Email

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\Email » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, craft\commerce\base\HasStoreInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\commerce\base\StoreTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

2.0

Email model.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
bcc	string, null – Bcc
behaviors	yii\base\Behavior – List of behaviors attached to this component.
cc	string, null – Cc
config	array
cpEditUrl	string
enabled	boolean – Is Enabled
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
language	string – The language.
name	string, null – Name
pdf	null, craft\commerce\models\Pdf
pdfId	integer, null – The PDF UID.
pdfTemplatePath	string
plainTextTemplatePath	string, null – Plain Text Template path
recipientType	string – Recipient Type
renderLanguage
replyTo	string, null – Reply to
scenario	string – The scenario that this model is in.
senderAddress	string, null
senderName	string, null – Placeholder value displayed for the sender name control panel settings field.
store	craft\commerce\models\Store
storeId	integer, null – Store ID
subject	string, null – Subject
templatePath	string, null – Template path
to	string, null – To
uid	string, null – UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

bcc

Type

string, null

Default value

null

Bcc

View source

cc

Type

string, null

Default value

null

Cc

View source

config

Type

array

Default value

null

View source

cpEditUrl

Type

string

Default value

null

Access

Read-only

Since

5.0.0

View source

enabled

Type

boolean

Default value

true

Is Enabled

View source

id

Type

integer, null

Default value

null

ID

View source

language

Type

string

Default value

\craft\commerce\records\Email::LOCALE_ORDER_LANGUAGE

The language.

View source

name

Type

string, null

Default value

null

Name

View source

pdf

Type

null, craft\commerce\models\Pdf

Default value

null

View source

pdfId

Type

integer, null

Default value

null

The PDF UID.

View source

pdfTemplatePath

Type

string

Default value

null

View source

plainTextTemplatePath

Type

string, null

Default value

null

Plain Text Template path

View source

recipientType

Type

string

Default value

\craft\commerce\records\Email::TYPE_CUSTOMER

Recipient Type

View source

renderLanguage

Default value

null

Access

Read-only

View source

replyTo

Type

string, null

Default value

null

Reply to

View source

senderAddress

Type

string, null

Default value

null

View source

senderName

Type

string, null

Default value

null

Since

5.0.0

Placeholder value displayed for the sender name control panel settings field.

If null (default), Craft’s MailSettings::$fromName will be used.

View source

subject

Type

string, null

Default value

null

Subject

View source

templatePath

Type

string, null

Default value

null

Template path

View source

to

Type

string, null

Default value

null

To

View source

uid

Type

string, null

Default value

null

UID

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()
__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.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors()	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterValidate()	This method is invoked after validation ends.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
attributeHints()	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeValidate()	This method is invoked before validation starts.
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.
clearErrors()	Removes errors for all attributes or a single attribute.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
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.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()	Returns the validators applicable to the current scenario.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getConfig()	Returns the field layout config for this email.
getCpEditUrl()
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getIterator()	Returns an iterator for traversing the attributes in the model.
getPdf()
getRenderLanguage()	Determines the language this pdf, if
getScenario()	Returns the scenario that this model is used in.
getSenderAddress()
getSenderName()
getStore()
getValidators()	Returns all the validators declared in rules().
hasErrors()	Returns a value indicating whether there is any validation error.
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.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
rules()	Returns the validation rules for attributes.
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario()	Sets the scenario for the model.
setSenderAddress()
setSenderName()
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

extraFields()

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

getConfig()

Since

3.2.0

Returns the field layout config for this email.

View source

Throws

• yii\base\InvalidConfigException

getCpEditUrl()

Since

5.0.0

View source

Returns

string

Throws

• yii\base\InvalidConfigException

getPdf()

View source

Throws

• yii\base\InvalidConfigException

getRenderLanguage()

Determines the language this pdf, if

View source

Arguments

• $order (craft\commerce\elements\Order, null)

getSenderAddress()

Since

5.0.0

View source

Arguments

• $parse (boolean)

Returns

string, null – Default email address Commerce system messages should be sent from.

If null (default), Craft’s MailSettings::$fromEmail will be used.

getSenderName()

Since

5.0.0

View source

Arguments

• $parse (boolean)

Returns

string, null – Placeholder value displayed for the sender name control panel settings field.

If null (default), Craft’s MailSettings::$fromName will be used.

setSenderAddress()

Since

5.0.0

View source

Arguments

• $senderAddress (string, null)

Returns

void

setSenderName()

Since

5.0.0

View source

Arguments

• $senderName (string, null)

Returns

void

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor()	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()	Extracts the root field names from nested fields.
resolveFields()	Determines which fields can be returned by toArray().

defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.