Skip to content

MailEvent ​

Type
Class
Namespace
craft\commerce\events
Inherits
craft\commerce\events\MailEvent » craft\events\CancelableEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Class MailEvent

View source

Public Properties ​

PropertyDescription
commerceEmailcraft\commerce\models\Email – Commerce email object
craftEmailcraft\mail\Message – Craft email object
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
isValidboolean – Whether to continue performing the action that called this event
namestring – The event name.
ordercraft\commerce\elements\Order – Commerce order
orderDataarray – Order data at the time the email sends.
orderHistorycraft\commerce\models\OrderHistory, null – The order history
senderobject, null – The sender of this event.

commerceEmail ​

Type
craft\commerce\models\Email
Default value
null

Commerce email object

View source

craftEmail ​

Type
craft\mail\Message
Default value
null

Craft email object

View source

order ​

Type
craft\commerce\elements\Order
Default value
null

Commerce order

View source

orderData ​

Type
array
Default value
null

Order data at the time the email sends.

View source

orderHistory ​

Type
craft\commerce\models\OrderHistory, null
Default value
null

The order history

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__construct()
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
once()Attaches an event handler to a class-level event, which will be triggered at most one time.
trigger()Triggers a class-level event.