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

View source

# 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

# commerceEmailId

Type
integer

The commerce email ID

View source

# orderData

Type
array

Order Data at time of order status change

View source

# orderHistoryId

Type
integer

The order history ID

View source

# orderId

Type
integer

Order ID

View source

# 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.
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.
execute()
getDescription() Returns the description that should be used for the job.
hasMethod() Returns a value indicating whether a method is defined.
hasProperty() Returns a value indicating whether a property is defined.
init() Initializes the object.

# execute()

View source

Arguments

  • $queue

# Protected Methods

Method Description
defaultDescription()
setProgress() Sets the job progress on the queue.

# defaultDescription()

View source