Globals / SendEmailOptions
# Namespace: SendEmailOptions
Optional attachments: Array<string>
Defined in src/generated/api.ts:2104 (opens new window)
Optional list of attachment IDs to send with this email. You must first upload each attachment separately in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded.
Optional bcc: Array<string>
Defined in src/generated/api.ts:2110 (opens new window)
Optional list of bcc destination email addresses
Optional body: string
Defined in src/generated/api.ts:2116 (opens new window)
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.
Optional cc: Array<string>
Defined in src/generated/api.ts:2122 (opens new window)
Optional list of cc destination email addresses
Optional charset: string
Defined in src/generated/api.ts:2128 (opens new window)
Optional from: string
Defined in src/generated/api.ts:2134 (opens new window)
Optional from address. If not set the source inbox address will be used for this field. Beware of potential spam penalties when setting this field to an address not used by the inbox. For custom email addresses use a custom domain.
Optional isHTML: boolean
Defined in src/generated/api.ts:2140 (opens new window)
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
Optional replyTo: string
Defined in src/generated/api.ts:2146 (opens new window)
Optional replyTo header
Optional sendStrategy: SendStrategyEnum
Defined in src/generated/api.ts:2152 (opens new window)
Optional strategy to use when sending the email
Optional subject: string
Defined in src/generated/api.ts:2158 (opens new window)
Optional email subject line
Optional template: string
Defined in src/generated/api.ts:2164 (opens new window)
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.
Optional templateVariables: any
Defined in src/generated/api.ts:2170 (opens new window)
Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.
Optional to: Array<string>
Defined in src/generated/api.ts:2176 (opens new window)
List of destination email addresses. 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).
Optional toContacts: Array<string>
Defined in src/generated/api.ts:2182 (opens new window)
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: string
Defined in src/generated/api.ts:2188 (opens new window)
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