Send a message
This action allows you to send a message by providing the appropriate options
URL
/api/v1/send/message
Access
Must be authenticated as a server.
If not authorised, a AccessDenied error will be returned.
Parameters
| Parameter | Type | Default |
|---|---|---|
|
to The e-mail addresses of the recipients (max 50) |
Array | null |
|
cc The e-mail addresses of any CC contacts (max 50) |
Array | null |
|
bcc The e-mail addresses of any BCC contacts (max 50) |
Array | null |
|
from The e-mail address for the From header |
String | null |
|
sender The e-mail address for the Sender header |
String | null |
|
subject The subject of the e-mail |
String | null |
|
tag The tag of the e-mail |
String | null |
|
reply_to Set the reply-to address for the mail |
String | null |
|
plain_body The plain text body of the e-mail |
String | null |
|
html_body The HTML body of the e-mail |
String | null |
|
attachments An array of attachments for this e-mail |
Array | null |
|
headers A hash of additional headers |
Hash | null |
|
bounce Is this message a bounce? |
Boolean | null |
Errors
| Error | Attributes |
|---|---|
|
ValidationError The provided data was not sufficient to send an email |
|
|
NoRecipients There are no recipients defined to received this message |
|
|
NoContent There is no content defined for this e-mail |
|
|
TooManyToAddresses The maximum number of To addresses has been reached (maximum 50) |
|
|
TooManyCCAddresses The maximum number of CC addresses has been reached (maximum 50) |
|
|
TooManyBCCAddresses The maximum number of BCC addresses has been reached (maximum 50) |
|
|
FromAddressMissing The From address is missing and is required |
|
|
UnauthenticatedFromAddress The From address is not authorised to send mail from this server |
|
|
AttachmentMissingName An attachment is missing a name |
|
|
AttachmentMissingData An attachment is missing data |
Response Data
This action will return a Hash.