ModelMailer module

Batch

Email batch containing one or multiple emails.

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

Mailer\Models\Frontend\Batch Mailer\Models\Api\Batch Mailer\Models\Backend\Batch Also in Mailer: Attachment Email 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 21

Take no arguments.

# getOpens()
int
Get the number of emails in this batch that have been opened. Multiple opens don't count multiple times.
# getClicks()
int
Get the number of emails in this batch that have been clicked. Multiple clicks don't count multiple times.
# getId()
?int
Get the batch id
# getPriority()
?int
Get the priority at which this batch should be sent. The lower the value, the higher the priority (0 => highest; 1 => high; 2 => medium; 3 => low; 4 => lowest)
# getSubject()
?string
Get the subject for the emails in this batch. Placeholders have not been replaced yet.
# getFromName()
?string
Get the email sender name
# getFromEmail()
?string
Get the email sender address
# getFromPerson()
?Person
Get the sending person
# getReplyTo()
?string
Get the reply to email address
# getReplyToName()
?string
Get the reply to name
# getOrigin()
?string
Get the origin of the email batch
# getSendAt()
?DateTime
Get the date at which the email should be sent. If this is null, the email is sent immediately.
# getCreated()
?DateTime
Get the date the record was created
# getModified()
?DateTime
Get the last modification date for the record
# getSite()
?Site
Get the site.
# getTemplate()
?Template
Get the template for this email batch.
# getEmails()
?Collection<Email>
Get the emails contained in this email batch.
# getAttachments()
?Collection<Attachment>
Get attachments for this email batch.
# 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 21

Read-only values on the record.

# opens
int
Get the number of emails in this batch that have been opened. Multiple opens don't count multiple times.
# clicks
int
Get the number of emails in this batch that have been clicked. Multiple clicks don't count multiple times.
# 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
Get the batch id
# priority
?int
Get the priority at which this batch should be sent. The lower the value, the higher the priority (0 => highest; 1 => high; 2 => medium; 3 => low; 4 => lowest)
# subject
?string
Get the subject for the emails in this batch. Placeholders have not been replaced yet.
# fromName
?string
Get the email sender name
# fromEmail
?string
Get the email sender address
# fromPerson
?Person
Get the sending person
# replyTo
?string
Get the reply to email address
# replyToName
?string
Get the reply to name
# origin
?string
Get the origin of the email batch
# sendAt
?DateTime
Get the date at which the email should be sent. If this is null, the email is sent immediately.
# created
?DateTime
Get the date the record was created
# modified
?DateTime
Get the last modification date for the record
# site
?Site
Get the site.
# template
?Template
Get the template for this email batch.
# emails
?Collection<Email>
Get the emails contained in this email batch.
# attachments
?Collection<Attachment>
Get attachments for this email batch.

Admin view

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

Properties 24

Take no arguments.

# getOpens()
int
Get the number of emails in this batch that have been opened. Multiple opens don't count multiple times.
# getClicks()
int
Get the number of emails in this batch that have been clicked. Multiple clicks don't count multiple times.
# 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
Get the batch id
# getPriority()
?int
Get the priority at which this batch should be sent. The lower the value, the higher the priority (0 => highest; 1 => high; 2 => medium; 3 => low; 4 => lowest)
# getSubject()
?string
Get the subject for the emails in this batch. Placeholders have not been replaced yet.
# getFromName()
?string
Get the email sender name
# getFromEmail()
?string
Get the email sender address
# getFromPerson()
?Person
Get the sending person
# getReplyTo()
?string
Get the reply to email address
# getReplyToName()
?string
Get the reply to name
# getOrigin()
?string
Get the origin of the email batch
# getSendAt()
?DateTime
Get the date at which the email should be sent. If this is null, the email is sent immediately.
# getCreated()
?DateTime
Get the date the record was created
# getModified()
?DateTime
Get the last modification date for the record
# getSite()
?Site
Get the site.
# getTemplate()
?Template
Get the template for this email batch.
# getEmails()
?Collection<Email>
Get the emails contained in this email batch.
# getAttachments()
?Collection<Attachment>
Get attachments for this email batch.
# 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