1
Send a message
LiNEX GIT edited this page 2024-06-11 15:14:16 +07:00

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 Array null
The e-mail addresses of the recipients (max 50)
cc Array null
The e-mail addresses of any CC contacts (max 50)
bcc Array null
The e-mail addresses of any BCC contacts (max 50)
from String null
The e-mail address for the From header
sender String null
The e-mail address for the Sender header
subject String null
The subject of the e-mail
tag String null
The tag of the e-mail
reply_to String null
Set the reply-to address for the mail
plain_body String null
The plain text body of the e-mail
html_body String null
The HTML body of the e-mail
attachments Array null
An array of attachments for this e-mail
headers Hash null
A hash of additional headers
bounce Boolean null
Is this message a bounce?

Errors

Error Attributes
ValidationError errors
The provided data was not sufficient to send an email A hash of error details
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.