Frontend | Backend | Api

Mailer\Models\Frontend\Batch

Email batch containing one or multiple emails.

Method Description Returns
getOpens() Get the number of emails in this batch that have been opened. Multiple opens don't count multiple times. int
getClicks() Get the number of emails in this batch that have been clicked. Multiple clicks don't count multiple times. int
getId() Get the batch id int
getPriority() 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) int
getSubject() Get the subject for the emails in this batch. Placeholders have not been replaced yet. string
getFromName() Get the email sender name string
getFromEmail() Get the email sender address string
getFromPerson() Get the sending person Person
getReplyTo() Get the reply to email address string
getOrigin() Get the origin of the email batch string
getSendAt() Get the date at which the email should be sent. If this is null, the email is sent immediately. DateTime
getCreated() Get the date the record was created DateTime
getModified() Get the last modification date for the record DateTime
getSite() Get the site. Site
getTemplate() Get the template for this email batch. Template
getEmails() Get the emails contained in this email batch. Collection (Email)
getAttachments() Get attachments for this email batch. Collection (Attachment)
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool