Абстрактный класс yii\mail\BaseMessage
| Наследование | yii\mail\BaseMessage » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\mail\MessageInterface |
| Подклассы | yii\swiftmailer\Message |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/mail/BaseMessage.php |
BaseMessage служит базовым классом, реализующим метод send(), необходимый для yii\mail\MessageInterface.
По умолчанию, send() будет использовать компонент приложения "mail" для отправки текущего сообщения. Компонент приложения "mail" должен быть экземпляром почтового клиента, реализующего yii\mail\MailerInterface.
См. также yii\mail\BaseMailer.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $bcc | массив | Адреса Bcc (скрытые получатели) этого сообщения. | yii\mail\MessageInterface |
| $cc | массив | Адреса Cc (дополнительные получатели) этого сообщения. | yii\mail\MessageInterface |
| $charset | строка | Кодировка символов этого сообщения. | yii\mail\MessageInterface |
| $from | строка | Отправитель | yii\mail\MessageInterface |
| $htmlBody | строка | HTML-содержимое сообщения. | yii\mail\MessageInterface |
| $mailer | yii\mail\MailerInterface | Экземпляр почтового клиента, который создал это сообщение. | yii\mail\BaseMessage |
| $replyTo | строка | Адрес для ответа на это сообщение. | yii\mail\MessageInterface |
| $subject | строка | Тема сообщения | yii\mail\MessageInterface |
| $textBody | строка | Текст сообщения. | yii\mail\MessageInterface |
| $to | массив | Получатели сообщения | yii\mail\MessageInterface |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __toString() | Магический метод PHP, возвращающий строковое представление этого объекта. | yii\mail\BaseMessage |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| attach() | Присоединяет существующий файл к сообщению электронной почты. | yii\mail\MessageInterface |
| attachContent() | Присоединяет указанное содержимое в качестве файла к сообщению электронной почты. | yii\mail\MessageInterface |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| embed() | Присоединяет файл и возвращает его CID-источник. | yii\mail\MessageInterface |
| embedContent() | Присоединяет содержимое в качестве файла и возвращает его CID-источник. | yii\mail\MessageInterface |
| getBcc() | Возвращает адреса получателей Bcc (скрытые копии) этого сообщения. | yii\mail\MessageInterface |
| getCc() | Возвращает адреса получателей Cc (дополнительные копии) этого сообщения. | yii\mail\MessageInterface |
| getCharset() | Возвращает кодировку символов этого сообщения. | yii\mail\MessageInterface |
| getFrom() | Возвращает отправителя сообщения. | yii\mail\MessageInterface |
| getReplyTo() | Возвращает адрес ответа для этого сообщения. | yii\mail\MessageInterface |
| getSubject() | Возвращает тему сообщения. | yii\mail\MessageInterface |
| getTo() | Возвращает получателя(ей) сообщения. | yii\mail\MessageInterface |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| send() | Отправляет это электронное сообщение. | yii\mail\BaseMessage |
| setBcc() | Устанавливает адреса получателей Bcc (скрытые копии) этого сообщения. | yii\mail\MessageInterface |
| setCc() | Устанавливает адреса получателей Cc (дополнительные копии) этого сообщения. | yii\mail\MessageInterface |
| setCharset() | Устанавливает кодировку символов этого сообщения. | yii\mail\MessageInterface |
| setFrom() | Устанавливает отправителя сообщения. | yii\mail\MessageInterface |
| setHtmlBody() | Устанавливает HTML-содержимое сообщения. | yii\mail\MessageInterface |
| setReplyTo() | Устанавливает адрес ответа для этого сообщения. | yii\mail\MessageInterface |
| setSubject() | Устанавливает тему сообщения. | yii\mail\MessageInterface |
| setTextBody() | Устанавливает текстовое содержимое сообщения (без форматирования). | yii\mail\MessageInterface |
| setTo() | Устанавливает получателя(ей) сообщения. | yii\mail\MessageInterface |
| toString() | Возвращает строковое представление этого сообщения. | yii\mail\MessageInterface |
Подробное описание свойств
$mailer общедоступное свойство
Экземпляр маил-отправителя, который создал это сообщение. Для независимо созданных сообщений это null.
public yii\mail\MailerInterface $mailer = null
Подробное описание методов
__toString() общедоступный метод
Магический метод PHP, который возвращает строковое представление этого объекта.
| общедоступный строка __toString ( ) | ||
|---|---|---|
| возвращает | строка |
Строковое представление этого объекта. |
send() общедоступный метод
Отправляет это электронное сообщение.
| общедоступный булево send ( yii\mail\MailerInterface $mailer = null ) | ||
|---|---|---|
| $mailer | yii\mail\MailerInterface |
Отправитель, который должен использоваться для отправки этого сообщения. Если отправитель не задан, сначала проверяется, установлен ли $mailer, и если нет, используется компонент приложения "mail". |
| возвращает | булево |
Успешно ли отправлено это сообщение. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mail-basemessage.html
