ModelMailer module

Email

A model in the Mailer module, with 24 members for templates, 24 API properties and 28 members for admin templates.

Mailer\Models\Frontend\Email Mailer\Models\Api\Email Mailer\Models\Backend\Email Also in Mailer: Attachment Batch Interaction Recipient Template
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 24

Take no arguments.

# getParsedSubject()
?string
Get the parsed (=> placeholders replaced) email subject
# getParsedBody()
?string
Get the parsed (=> placeholders replaced) email body
# getContentType()
string
Determine the content type of the email
# getFirstToPerson()
?Person
Get the first person this email is addressed to
# getOpens()
int
Get the number of open interactions for this email
# getClicks()
int
Get the number of click interactions for this email
# getId()
?int
# getUuid()
?string
# getVariables()
?array
# getError()
?string
# getExternalId()
?string
# getSmtpId()
?string
# getQueueId()
?string
# getStatus()
?string
# getCreated()
?DateTime
# getModified()
?DateTime
# getSent()
?DateTime
# getBatch()
?Batch
# getInteractions()
?Collection<Interaction>
# getSite()
?Site
# getRecipients()
?Collection<Recipient>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 24

Read-only values on the record.

# parsedSubject
?string
Get the parsed (=> placeholders replaced) email subject
# parsedBody
?string
Get the parsed (=> placeholders replaced) email body
# contentType
string
Determine the content type of the email
# firstToPerson
?Person
Get the first person this email is addressed to
# opens
int
Get the number of open interactions for this email
# clicks
int
Get the number of click interactions for this email
# deleteUrl Not in Templates
?string
Get the url for deleting the record.
# manageUrl Not in Templates
?string
Get the url for managing records.
# id
?int
# uuid
?string
# variables
?array
# error
?string
# externalId
?string
# smtpId
?string
# queueId
?string
# status
?string
# created
?DateTime
# modified
?DateTime
# sent
?DateTime
# batch
?Batch
# interactions
?Collection<Interaction>
# site
?Site
# recipients
?Collection<Recipient>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 28

Take no arguments.

# getParsedSubject()
?string
Get the parsed (=> placeholders replaced) email subject
# getParsedBody()
?string
Get the parsed (=> placeholders replaced) email body
# getContentType()
string
Determine the content type of the email
# getFirstToPerson()
?Person
Get the first person this email is addressed to
# getOpens()
int
Get the number of open interactions for this email
# getClicks()
int
Get the number of click interactions for this email
# getDeleteUrl() Not in Templates
?string
Get the url for deleting the record.
# getManageUrl() Not in Templates
?string
Get the url for managing records.
# getId()
?int
# getUuid()
?string
# getVariables()
?array
# getError()
?string
# getExternalId()
?string
# getSmtpId()
?string
# getQueueId()
?string
# getStatus()
?string
# getCreated()
?DateTime
# getModified()
?DateTime
# getSent()
?DateTime
# getBatch()
?Batch
# getInteractions()
?Collection<Interaction>
# getSite()
?Site
# getRecipients()
?Collection<Recipient>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getShowEmailPath() Admin only
string
Get the path for showing the (rendered) email