Класс yii\mail\MailEvent
| Наследование | yii\mail\MailEvent » yii\base\Event » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/mail/MailEvent.php |
MailEvent представляет параметр события, используемый для событий, запускаемых yii\mail\BaseMailer.
Установив свойство $isValid, можно контролировать, следует ли продолжать выполнение действия.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $data | смешанный | Данные, передаваемые в yii\base\Component::on() при добавлении обработчика событий. | yii\base\Event |
| $handled | boolean | Обработано ли событие. | yii\base\Event |
| $isSuccessful | boolean | Успешно ли было отправлено сообщение. | yii\mail\MailEvent |
| $isValid | boolean | Следует ли продолжить отправку письма. Обработчики событий yii\mail\BaseMailer::EVENT_BEFORE_SEND могут установить это свойство, чтобы решить, продолжать отправку или нет. | yii\mail\MailEvent |
| $message | yii\mail\MessageInterface | Отправляемое сообщение электронной почты. | yii\mail\MailEvent |
| $name | string | Имя события. | yii\base\Event |
| $sender | object | Отправитель этого события. | yii\base\Event |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
Подробное описание свойств
$isSuccessful публичное свойство
Успешно ли было отправлено сообщение.
public boolean $isSuccessful = null
$isValid публичное свойство
Следует ли продолжить отправку письма. Обработчики событий yii\mail\BaseMailer::EVENT_BEFORE_SEND могут установить это свойство, чтобы решить, продолжать отправку или нет.
public boolean $isValid = true
$message публичное свойство
Отправляемое сообщение электронной почты.
public yii\mail\MessageInterface $message = null
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mail-mailevent.html
