SendEmail ​
- Type
- Class
- Namespace
- craft\commerce\queue\jobs
- Inherits
- craft\commerce\queue\jobs\SendEmail » craft\queue\BaseJob » yii\base\BaseObject
- Implements
- craft\queue\JobInterface, yii\base\Configurable, yii\queue\RetryableJobInterface
Public Properties ​
| Property | Description |
|---|---|
| commerceEmailId | integer – The commerce email ID |
| description | string, null – The configured job description. |
| orderData | array – Order Data at time of order status change |
| orderHistoryId | integer – The order history ID |
| orderId | integer – Order ID |
| ttr | integer – Time to reserve in seconds |
commerceEmailId ​
- Type
- integer
- Default value
null
The commerce email ID
orderData ​
- Type
- array
- Default value
null
Order Data at time of order status change
orderHistoryId ​
- Type
- integer
- Default value
null
The order history ID
orderId ​
- Type
- integer
- Default value
null
Order ID
ttr ​
- Type
- integer
- Default value
null- Access
- Read-only
Time to reserve in seconds
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. |
| __wakeup() | |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canRetry() | |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| execute() | |
| getDescription() | Returns the description that should be used for the job. |
| getTtr() | |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
canRetry() ​
Arguments ​
Returns ​
execute() ​
Arguments ​
$queue(yii\queue\Queue, craft\queue\QueueInterface) – The queue the job belongs to
getTtr() ​
Returns ​
integer – Time to reserve in seconds
Protected Methods ​
| Method | Description |
|---|---|
| defaultDescription() | Returns a default description for getDescription(). |
| setProgress() | Sets the job progress on the queue. |
defaultDescription() ​
Returns a default description for getDescription().
TIP
Run the description through craft\i18n\Translation::prep() rather than Craft::t() so it can be lazy-translated for users’ preferred languages rather that the current app language.