SendEmail
- Type
- Class
- Namespace
- craft\commerce\queue\jobs
- Inherits
- craft\commerce\queue\jobs\SendEmail » craft\queue\BaseJob (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- craft\queue\JobInterface (opens new window), yii\base\Configurable (opens new window), yii\queue\RetryableJobInterface (opens new window)
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| commerceEmailId | integer (opens new window) – The commerce email ID |
| description (opens new window) | string (opens new window), null (opens new window) – The configured job description. |
| orderData | array (opens new window) – Order Data at time of order status change |
| orderHistoryId | integer (opens new window) – The order history ID |
| orderId | integer (opens new window) – Order ID |
| ttr | integer (opens new window) – Time to reserve in seconds |
# commerceEmailId
- Type
- integer (opens new window)
- Default value
null
The commerce email ID
View source (opens new window)
# orderData
- Type
- array (opens new window)
- Default value
null
Order Data at time of order status change
View source (opens new window)
# orderHistoryId
- Type
- integer (opens new window)
- Default value
null
The order history ID
View source (opens new window)
# orderId
- Type
- integer (opens new window)
- Default value
null
Order ID
View source (opens new window)
# ttr
- Type
- integer (opens new window)
- Default value
null- Access
- Read-only
Time to reserve in seconds
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __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. |
| __wakeup() (opens new window) | |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canRetry() | |
| 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. |
| execute() | |
| getDescription() (opens new window) | Returns the description that should be used for the job. |
| getTtr() | |
| 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. |
# canRetry()
View source (opens new window)
Arguments
$attempt(integer (opens new window)) – Number$error(Exception (opens new window), Throwable (opens new window)) – From last execute of the job
Returns
# execute()
View source (opens new window)
Arguments
$queue(yii\queue\Queue (opens new window), craft\queue\QueueInterface (opens new window)) – The queue the job belongs to
# getTtr()
View source (opens new window)
Returns
integer (opens new window) – Time to reserve in seconds
# Protected Methods
| Method | Description |
|---|---|
| defaultDescription() | Returns a default description for getDescription() (opens new window). |
| setProgress() (opens new window) | Sets the job progress on the queue. |
# defaultDescription()
Returns a default description for getDescription() (opens new window).
TIP
Run the description through craft\i18n\Translation::prep() (opens new window) rather than Craft::t() (opens new window) so it can be lazy-translated for users’ preferred languages rather that the current app language.
View source (opens new window)