SendBulkTemplatedEmail

Composes an email message to multiple destinations. The message body is created using an email template.

In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The total size of the message, including attachments, must be less than 10 MB.
Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.
The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.

Type: String

Required: No

DefaultTags.member.N

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Type: Array of MessageTag objects

Required: No

DefaultTemplateData

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Type: String

Length Constraints: Maximum length of 262144.

Required: No

Destinations.member.N

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Type: Array of BulkEmailDestination objects

Required: Yes

ReplyToAddresses.member.N

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Type: Array of strings

Required: No

ReturnPath

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Type: String

Required: No

ReturnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No

Source

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Note

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Type: String

Required: Yes

SourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No

Template

The template to use when sending this email.

Type: String

Required: Yes

TemplateArn

The ARN of the template to use when sending this email.

Type: String

Required: No

Response Elements

The following element is returned by the service.

Status.member.N

The unique message identifier returned from the SendBulkTemplatedEmail action.

Type: Array of BulkEmailDestinationStatus objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountSendingPaused

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

HTTP Status Code: 400

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

ConfigurationSetSendingPaused

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

HTTP Status Code: 400

MailFromDomainNotVerified

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

HTTP Status Code: 400

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

HTTP Status Code: 400

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

SendBulkTemplatedEmail

Request Parameters

Response Elements

Errors

See Also