Emails

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\Emails » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Email service.

View source

# Public Properties

Property Description
allEmails craft\commerce\models\Email[]
allEnabledEmails craft\commerce\models\Email[]
behaviors yii\base\Behavior – List of behaviors attached to this component

# allEmails

Type
craft\commerce\models\Email[]
Access
Read-only

View source

# allEnabledEmails

Type
craft\commerce\models\Email[]
Access
Read-only

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone() This method is called after the object is created by cloning an existing one.
__construct() Constructor.
__get() Returns the value of a component property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets the value of a component property.
__unset() Sets a component property to be null.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
behaviors() Returns a list of behaviors that this component should behave as.
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.
deleteEmailById() Delete an email by its ID.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
getAllEmails() Get all emails.
getAllEmailsByOrderStatusId() Get all emails by an order status ID.
getAllEnabledEmails() Get all emails that are enabled.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getEmailById() Get an email by its ID.
handleChangedEmail() Handle gateway status change.
handleDeletedEmail() Handle email getting deleted.
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event.
hasMethod() Returns a value indicating whether a method is defined.
hasProperty() Returns a value indicating whether a property is defined for this component.
init() Initializes the object.
off() Detaches an existing event handler from this component.
on() Attaches an event handler to an event.
saveEmail() Save an email.
sendEmail() Send a commerce email.
trigger() Triggers an event.

# deleteEmailById()

Delete an email by its ID.

View source

Arguments

Returns

boolean

# getAllEmails()

Get all emails.

View source

Returns

craft\commerce\models\Email[]

# getAllEmailsByOrderStatusId()

Get all emails by an order status ID.

View source

Arguments

Returns

craft\commerce\models\Email[]

# getAllEnabledEmails()

Get all emails that are enabled.

View source

Returns

craft\commerce\models\Email[]

# getEmailById()

Get an email by its ID.

View source

Arguments

Returns

craft\commerce\models\Email, null

# handleChangedEmail()

Handle gateway status change.

View source

Arguments

Returns

void

Throws

# handleDeletedEmail()

Handle email getting deleted.

View source

Arguments

Returns

void

# saveEmail()

Save an email.

View source

Arguments

Returns

boolean

Throws

# sendEmail()

Send a commerce email.

View source

Arguments

Returns

boolean – $result

Throws

# Constants

Constant Description
CONFIG_EMAILS_KEY

# Events

# EVENT_AFTER_DELETE_EMAIL

Type
craft\commerce\events\EmailEvent

The event that is triggered after an email is deleted.

use craft\commerce\events\EmailEvent;
use craft\commerce\services\Emails;
use craft\commerce\models\Email;
use yii\base\Event;

Event::on(
    Emails::class,
    Emails::EVENT_AFTER_DELETE_EMAIL,
    function(EmailEvent $event) {
        // @var Email $email
        $email = $event->email;

        // ...
    }
);

# EVENT_AFTER_SAVE_EMAIL

Type
craft\commerce\events\EmailEvent

The event that is triggered after an email is saved.

use craft\commerce\events\EmailEvent;
use craft\commerce\services\Emails;
use craft\commerce\models\Email;
use yii\base\Event;

Event::on(
    Emails::class,
    Emails::EVENT_AFTER_SAVE_EMAIL,
    function(EmailEvent $event) {
        // @var Email $email
        $email = $event->email;
        // @var bool $isNew
        $isNew = $event->isNew;

        // ...
    }
);

# EVENT_AFTER_SEND_MAIL

Type
craft\commerce\events\MailEvent

The event that is triggered after an email has been sent out.

use craft\commerce\events\MailEvent;
use craft\commerce\services\Emails;
use craft\commerce\elements\Order;
use craft\commerce\models\Email;
use craft\commerce\models\OrderHistory;
use craft\mail\Message;
use yii\base\Event;

Event::on(
    Emails::class,
    Emails::EVENT_AFTER_SEND_MAIL,
    function(MailEvent $event) {
        // @var Message $message
        $message = $event->craftEmail;
        // @var Email $email
        $email = $event->commerceEmail;
        // @var Order $order
        $order = $event->order;
        // @var OrderHistory $history
        $history = $event->orderHistory;

        // Add the email address to an external CRM
        // ...
    }
);

# EVENT_BEFORE_DELETE_EMAIL

Type
craft\commerce\events\EmailEvent

The event that is triggered before an email is deleted.

use craft\commerce\events\EmailEvent;
use craft\commerce\services\Emails;
use craft\commerce\models\Email;
use yii\base\Event;

Event::on(
    Emails::class,
    Emails::EVENT_BEFORE_DELETE_EMAIL,
    function(EmailEvent $event) {
        // @var Email $email
        $email = $event->email;

        // ...
    }
);

# EVENT_BEFORE_SAVE_EMAIL

Type
craft\commerce\events\EmailEvent

The event that is triggered before an email is saved.

use craft\commerce\events\EmailEvent;
use craft\commerce\services\Emails;
use craft\commerce\models\Email;
use yii\base\Event;

Event::on(
    Emails::class,
    Emails::EVENT_BEFORE_SAVE_EMAIL,
    function(EmailEvent $event) {
        // @var Email $email
        $email = $event->email;
        // @var bool $isNew
        $isNew = $event->isNew;

        // ...
    }
);

# EVENT_BEFORE_SEND_MAIL

Type
craft\commerce\events\MailEvent

The event that is triggered before an email is sent out.

You may set the isValid property to false on the event to prevent the email from being sent.

use craft\commerce\events\MailEvent;
use craft\commerce\services\Emails;
use craft\commerce\elements\Order;
use craft\commerce\models\Email;
use craft\commerce\models\OrderHistory;
use craft\mail\Message;
use yii\base\Event;

Event::on(
    Emails::class,
    Emails::EVENT_BEFORE_SEND_MAIL,
    function(MailEvent $event) {
        // @var Message $message
        $message = $event->craftEmail;
        // @var Email $email
        $email = $event->commerceEmail;
        // @var Order $order
        $order = $event->order;
        // @var OrderHistory $history
        $history = $event->orderHistory;

        // Use `$event->isValid = false` to prevent sending
        // based on some business rules or client preferences
        // ...
    }
);