Emails
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Emails » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Email service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| allEmails | craft\commerce\models\Email[] |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component |
# allEmails
- Type
- craft\commerce\models\Email[]
- Access
- Read-only
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| deleteEmailById() | Delete an email by its ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getAllEmails() | Get all emails. |
| getAllEmailsByOrderStatusId() | Get all emails by an order status ID. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | 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() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
| init() (opens new window) | Initializes the object. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| saveEmail() | Save an email. |
| sendEmail() | Send a commerce email. |
| trigger() (opens new window) | Triggers an event. |
# deleteEmailById()
Delete an email by its ID.
View source (opens new window)
Arguments
Returns
# getAllEmails()
Get all emails.
View source (opens new window)
Returns
# getAllEmailsByOrderStatusId()
Get all emails by an order status ID.
View source (opens new window)
Arguments
Returns
# getEmailById()
Get an email by its ID.
View source (opens new window)
Arguments
Returns
craft\commerce\models\Email, null (opens new window)
# handleChangedEmail()
Handle gateway status change.
View source (opens new window)
Arguments
Returns
void
Throws
- Throwable (opens new window)
if reasons
# handleDeletedEmail()
Handle email getting deleted.
View source (opens new window)
Arguments
Returns
void
# saveEmail()
Save an email.
View source (opens new window)
Arguments
$email(craft\commerce\models\Email)$runValidation(boolean (opens new window))
Returns
Throws
- yii\base\Exception (opens new window)
- yii\base\ErrorException (opens new window)
- yii\base\NotSupportedException (opens new window)
- yii\web\ServerErrorHttpException (opens new window)
# sendEmail()
Send a commerce email.
View source (opens new window)
Arguments
$email(craft\commerce\models\Email)$order(craft\commerce\elements\Order)$orderHistory(craft\commerce\models\OrderHistory)
Returns
boolean (opens new window) – $result
# Constants
| Constant | Description |
|---|---|
CONFIG_EMAILS_KEY |
# Events
# EVENT_AFTER_DELETE_EMAIL
The event that is triggered after an email is deleted.
# EVENT_AFTER_SAVE_EMAIL
The event that is triggered after an email is saved.
# EVENT_AFTER_SEND_MAIL
The event that is raised after an email is sent
Plugins can get notified after an email has been sent out.
use craft\commerce\events\MailEvent;
use craft\commerce\services\Emails;
use yii\base\Event;
Event::on(Emails::class, Emails::EVENT_AFTER_SEND_MAIL, function(MailEvent $e) {
// Perhaps add the email to a CRM system
});
# EVENT_BEFORE_DELETE_EMAIL
The event that is triggered before an email is deleted.
# EVENT_BEFORE_SAVE_EMAIL
The event that is triggered before an email is saved.
# EVENT_BEFORE_SEND_MAIL
The event that is raised before an email is sent.
You may set craft\commerce\events\MailEvent::$isValid (opens new window) to false to prevent the email from being sent.
Plugins can get notified before an email is being sent out.
use craft\commerce\events\MailEvent;
use craft\commerce\services\Emails;
use yii\base\Event;
Event::on(Emails::class, Emails::EVENT_BEFORE_SEND_MAIL, function(MailEvent $e) {
// Maybe prevent the email based on some business rules or client preferences.
});