Emails
This section lists your emails and shows you how to manage them.
List emails
Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region.
path Parameters
regionThe region you want to target
query Parameters
pagepage_sizeproject_id(Optional) ID of the Project in which to list the emails. (UUID format)
domain_id(Optional) ID of the domain for which to list the emails. (UUID format)
message_id(Optional) ID of the message for which to list the emails. (UUID format)
since(Optional) List emails created after this date. (RFC 3339 format)
until(Optional) List emails created before this date. (RFC 3339 format)
mail_from(Optional) List emails sent with this sender's email address.
mail_toDeprecated. List emails sent to this recipient's email address.
mail_rcpt(Optional) List emails sent to this recipient's email address.
(Optional) List emails with any of these statuses.
subject(Optional) List emails with this subject.
search(Optional) List emails by searching to all fields.
order_by(Optional) List emails corresponding to specific criteria.
(Optional) List emails containing only specific flags.
List emails › Responses
total_countNumber of emails matching the requested criteria.
Single page of emails matching the requested criteria.
Send an email
You must specify the region, the sender and the recipient's information and the project_id to send an email from a checked domain.
path Parameters
regionThe region you want to target
Send an email › Request Body
Sender information. Must be from a checked domain declared in the Project.
An array of the primary recipient's information.
An array of the carbon copy recipient's information.
An array of the blind carbon copy recipient's information.
subjectSubject of the email.
textText content.
htmlHTML content.
project_idID of the Project in which to create the email. (UUID format)
Array of attachments.
send_beforeMaximum date to deliver the email. (RFC 3339 format)
Array of additional headers as key-value.
Send an email › Responses
Single page of emails matching the requested criteria.
Get an email
Retrieve information about a specific email using the email_id and region parameters.
path Parameters
regionThe region you want to target
email_idID of the email to retrieve. (UUID format)
Get an email › Responses
idTechnical ID of the email.
message_idMessage ID of the email.
project_idID of the Project to which the email belongs.
mail_fromEmail address of the sender.
mail_rcptEmail address of the recipient.
rcpt_typeType of recipient.
subjectSubject of the email.
created_atCreation date of the email object. (RFC 3339 format)
updated_atLast update of the email object. (RFC 3339 format)
statusStatus of the email.
status_detailsAdditional status information.
try_countNumber of attempts to send the email.
Information about the last three attempts to send the email.
Flags categorize emails. They allow you to obtain more information about recurring errors, for example.
rcpt_toDeprecated. Email address of the recipient.
Cancel an email
You can cancel the sending of an email if it has not been sent yet. You must specify the region and the email_id of the email you want to cancel.
path Parameters
regionThe region you want to target
email_idID of the email to cancel. (UUID format)
Cancel an email › Responses
idTechnical ID of the email.
message_idMessage ID of the email.
project_idID of the Project to which the email belongs.
mail_fromEmail address of the sender.
mail_rcptEmail address of the recipient.
rcpt_typeType of recipient.
subjectSubject of the email.
created_atCreation date of the email object. (RFC 3339 format)
updated_atLast update of the email object. (RFC 3339 format)
statusStatus of the email.
status_detailsAdditional status information.
try_countNumber of attempts to send the email.
Information about the last three attempts to send the email.
Flags categorize emails. They allow you to obtain more information about recurring errors, for example.
rcpt_toDeprecated. Email address of the recipient.