0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/mailer -H 'Accept: application/json'

Class	Description
Yiisoft\Mailer\BaseMailer	`BaseMailer` serves as a base class that implements the basic functions required by {@see MailerInterface}.
Yiisoft\Mailer\Debug\MailerCollector
Yiisoft\Mailer\Debug\MailerInterfaceProxy
Yiisoft\Mailer\Event\AfterSend	`AfterSend` event is triggered right after sent the message.
Yiisoft\Mailer\Event\BeforeSend	`BeforeSend` event is triggered right before sending the message.
Yiisoft\Mailer\File	`File` is a data object that stores data for attaching a file to a mail message.
Yiisoft\Mailer\FileMailer	`FileMailer` is a mock mailer that save email messages in files instead of sending them.
Yiisoft\Mailer\HeadersNormalizer
Yiisoft\Mailer\HtmlToTextBodyConverter	Utility for converting HTML body to text body.
Yiisoft\Mailer\MailerInterface	`MailerInterface` is the interface that should be implemented by mailers.
Yiisoft\Mailer\Message	Mail message class that represents the settings and content of an email, such as the sender, recipient, subject, body, etc. Messages are sent by a {@see MailerInterface}.
Yiisoft\Mailer\MessageInterface	`MessageInterface` is the interface that should be implemented by mail message classes.
Yiisoft\Mailer\MessageSettings	`MessageSettings` provides default and extra message settings.
Yiisoft\Mailer\NullMailer	This mailer can be used to avoid sending messages.
Yiisoft\Mailer\SendResults	Result of {@see MailerInterface::sendMultiple()}.
Yiisoft\Mailer\StubMailer	This mailer keeps messages in memory and doesn't send them.