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

PropertyDescription
$commerceEmailcraft\commerce\models\Email – Commerce email object
$craftEmailcraft\mail\Message – Craft email object
$datamixed – The data that is passed to \craft\commerce\events\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
$orderHistorycraft\commerce\models\OrderHistory – The order history
$senderobject – The sender of this event.

$commerceEmail

Signature

public craft\commerce\models\Email $commerceEmail = null

$craftEmail

Type
craft\mail\Message

Craft email object

View source

Signature

public craft\mail\Message $craftEmail = null

$order

Signature

public craft\commerce\elements\Order $order = null

$orderHistory

Signature

public craft\commerce\models\OrderHistory $orderHistory = null

Public Methods

MethodDescription
__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.