POST /a/mailer/send
Send an email to a user or any email address
Body Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| Attachments | List of attachments | array | |
| Cc | List of target users to put in CC | array | |
| ContentHtml | HTML content used for the body | string | |
| ContentMarkdown | Markdown content used for the body | string | |
| ContentPlain | Plain-text content used for the body, if not set will be generated from the ContentHtml | string | |
| DateSent | Date of sending | string | |
| From | User object used to compute the From header | #/definitions/mailerUser | |
| Retries | Number of retries after failed attempts (used internally) | integer | |
| Sender | User object used to compute the Sender header | #/definitions/mailerUser | |
| Subject | String used as subject for the email | string | |
| TemplateData | Key/values to pass to the template | object | |
| TemplateId | Mail Template Id refers to predefined templates | string | |
| ThreadIndex | Not used, could be used to create conversations | string | |
| ThreadUuid | Not used, could be used to create conversations | string | |
| To | List of target users to send the mail to | array | |
| sendErrors | Errors stacked on failed attempts | array |
Body Example
{
"Attachments": [
"string"
],
"Cc": [
{
"Address": "string",
"Language": "string",
"Name": "string",
"Uuid": "string"
}
],
"ContentHtml": "string",
"ContentMarkdown": "string",
"ContentPlain": "string",
"DateSent": "string",
"From": {
"Address": "string",
"Language": "string",
"Name": "string",
"Uuid": "string"
},
"Retries": 10,
"Sender": {
"Address": "string",
"Language": "string",
"Name": "string",
"Uuid": "string"
},
"Subject": "string",
"TemplateData": {},
"TemplateId": "string",
"ThreadIndex": "string",
"ThreadUuid": "string",
"To": [
{
"Address": "string",
"Language": "string",
"Name": "string",
"Uuid": "string"
}
],
"sendErrors": [
"string"
]
}
Response Example (200)
Response Type /definitions/mailerSendMailResponse
{
"Success": true
}