MailEvent

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

Class MailEvent

View source

# Public Properties

Property Description
commerceEmail craft\commerce\models\Email – Commerce email object
craftEmail craft\mail\Message – Craft email object
data mixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handled boolean – Whether the event is handled.
isValid boolean – Whether to continue performing the action that called this event
name string – The event name.
order craft\commerce\elements\Order – Commerce order
orderData array – Order data at the time the email sends.
orderHistory craft\commerce\models\OrderHistory – The order history
sender object – The sender of this event.

# commerceEmail

Type
craft\commerce\models\Email

Commerce email object

View source

# craftEmail

Type
craft\mail\Message

Craft email object

View source

# order

Type
craft\commerce\elements\Order

Commerce order

View source

# orderData

Type
array

Order data at the time the email sends.

View source

# orderHistory

Type
craft\commerce\models\OrderHistory

The order history

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__construct() Constructor.
__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.
trigger() Triggers a class-level event.