| Property | Description | Returns |
|---|---|---|
| opens | Get the number of emails in this batch that have been opened. Multiple opens don't count multiple times. | int |
| clicks | Get the number of emails in this batch that have been clicked. Multiple clicks don't count multiple times. | int |
| hateoasLinks | Get the HATEOAS links for the record | array |
| deleteUrl | Get the url for deleting the record. | string |
| manageUrl | Get the url for managing records. | string |
| id | Get the batch id | int |
| priority | 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 |
| subject | Get the subject for the emails in this batch. Placeholders have not been replaced yet. | string |
| fromName | Get the email sender name | string |
| fromEmail | Get the email sender address | string |
| fromPerson | Get the sending person | Person |
| replyTo | Get the reply to email address | string |
| origin | Get the origin of the email batch | string |
| sendAt | Get the date at which the email should be sent. If this is null, the email is sent immediately. | DateTime |
| created | Get the date the record was created | DateTime |
| modified | Get the last modification date for the record | DateTime |
| site | Get the site. | Site |
| template | Get the template for this email batch. | Template |
| emails | Get the emails contained in this email batch. | Collection (Email) |
| attachments | Get attachments for this email batch. | Collection (Attachment) |
Mailer\Models\Api\Batch
Email batch containing one or multiple emails.