没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\mail\MailEvent

继承yii\mail\MailEvent » yii\base\Event » yii\base\BaseObject
实现yii\base\Configurable
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/mail/MailEvent.php

MailEvent 表示用于由 yii\mail\BaseMailer 触发的事件参数。

通过设置 $isValid 属性,可以控制是否继续运行该操作。

公共属性

隐藏继承的属性

属性类型描述被定义在
$data mixed The data that is passed to yii\base\Component::on() when attaching an event handler. yii\base\Event
$handled boolean Whether the event is handled. 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 The event name. yii\base\Event
$sender object The sender of this event. yii\base\Event

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
hasHandlers() Returns a value indicating whether there is any handler attached to the specified class-level event. yii\base\Event
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
off() 从类级事件中卸载事件处理程序。 yii\base\Event
offAll() 卸载所有已注册的类级事件处理程序。 yii\base\Event
on() Attaches an event handler to a class-level event. yii\base\Event
trigger() 触发类级事件。 This method will cause invocation of event handlers that are attached to the named event for the specified class and all its parent classes. yii\base\Event

属性详情

$isSuccessful 公共 属性

消息是否成功发送。

public boolean $isSuccessful null
$isValid 公共 属性

是否继续发送电子邮件。 yii\mail\BaseMailer::EVENT_BEFORE_SEND 的事件处理程序可以设置此属性 来决定是否继续发送。

public boolean $isValid true
$message 公共 属性

正在发送的邮件消息。