SendMailboxEmailRequest
Request DTO for sending a new email from a tenant's connected mailbox.
Properties
| Name | Type | Description |
|---|---|---|
| subject | string | Email subject line (optional; defaults to an empty subject when omitted) |
Email subject line (optional; defaults to an empty subject when omitted) | ||
| htmlBody | string | HTML body of the email |
HTML body of the email | ||
| plainTextBody | string | Plain text body of the email (used as fallback when HTML is not supported) |
Plain text body of the email (used as fallback when HTML is not supported) | ||
| to* | array of EmailRecipientDto | List of To recipients (at least one required) |
List of To recipients (at least one required) | ||
| cc | array of EmailRecipientDto | List of CC recipients (optional) |
List of CC recipients (optional) | ||
| bcc | array of EmailRecipientDto | List of BCC recipients (optional) |
List of BCC recipients (optional) | ||
| attachments | array of EmailAttachmentDto | List of attachments as base64-encoded content (optional) |
List of attachments as base64-encoded content (optional) | ||
| addHeaderFooter | boolean | Whether to wrap the body with the tenant's configured header/footer before sending. Defaults to false when omitted. |
Whether to wrap the body with the tenant's configured header/footer before sending. Defaults to false when omitted. | ||
| practiceDocumentCodes | array of string | Codes of practice documents (tenant document library) to attach. Resolved to file |
Codes of practice documents (tenant document library) to attach. Resolved to file | ||
| scheduledAt | string | When set, the email is not sent now: a scheduled send is created and dispatched at this |
When set, the email is not sent now: a scheduled send is created and dispatched at this | ||
JSON Example
{
"subject": "string",
"htmlBody": "string",
"plainTextBody": "string",
"to": [
{
"email": "...",
"name": "..."
}
],
"cc": [
{
"email": "...",
"name": "..."
}
]
}