|toContacts ||[UUID] ||Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. ||[optional] |
|toGroup ||UUID ||Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients ||[optional] |
|to ||[String] ||List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. ||[optional] |
|from ||String ||Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets ( |
My inbox <email@example.com>). If no sender is set the source inbox address will be used for this field. If you set
true the from field will include the inbox name as a display name:
inbox_name <firstname.lastname@example.org>. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.
|cc ||[String] ||Optional list of cc destination email addresses ||[optional] |
|bcc ||[String] ||Optional list of bcc destination email addresses ||[optional] |
|subject ||String ||Optional email subject line ||[optional] |
|replyTo ||String ||Optional replyTo header ||[optional] |
|body ||String ||Optional contents of email. If body contains HTML then set |
isHTML to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with
toGroup contact variables or
templateVariables data. If you need more templating control consider creating a template and using the
template property instead of the body.
|html ||Bool ||Optional HTML flag to indicate that contents is HTML. Set's a |
content-type: text/html for email. (Deprecated: use
|isHTML ||Bool ||Optional HTML flag. If true the |
content-type of the email will be
text/html. Set to true when sending HTML to ensure proper rending on email clients
|charset ||String ||Optional charset ||[optional] |
|attachments ||[String] ||Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support |
base64 file encoding, and octet stream binary uploads. See the
UploadController for available methods.
|templateVariables ||[String: AnyCodable] ||Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. ||[optional] |
|template ||UUID ||Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of |
templateVariables. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.
|sendStrategy ||String ||How an email should be sent based on its recipients ||[optional] |
|useInboxName ||Bool ||Use name of inbox as sender email address name. Will construct RFC 5322 email address with |
Inbox name <email@example.com> if the inbox has a name.
|addTrackingPixel ||Bool ||Add tracking pixel to email ||[optional] |
|filterBouncedRecipients ||Bool ||Filter recipients to remove any bounced recipients from to, bcc, and cc before sending ||[optional] |
|validateEmailAddresses ||String ||Validate recipient email addresses before sending ||[optional] |