Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ses ]

send-bulk-templated-email

Description

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

In order to send email using the send-bulk-templated-email 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 create-template 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.

See also: AWS API Documentation

Synopsis

  send-bulk-templated-email
--source <value>
[--source-arn <value>]
[--reply-to-addresses <value>]
[--return-path <value>]
[--return-path-arn <value>]
[--configuration-set-name <value>]
[--default-tags <value>]
--template <value>
[--template-arn <value>]
[--default-template-data <value>]
--destinations <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--source (string)

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 .

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= . For more information, see RFC 2047 .

--source-arn (string)

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 .

--reply-to-addresses (list)

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

Syntax:

"string" "string" ...

--return-path (string)

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.

--return-path-arn (string)

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 .

--configuration-set-name (string)

The name of the configuration set to use when you send an email using send-bulk-templated-email .

--default-tags (list)

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

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--template (string)

The template to use when sending this email.

--template-arn (string)

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

--default-template-data (string)

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.

--destinations (list)

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.

Shorthand Syntax:

Destination={ToAddresses=[string,string],CcAddresses=[string,string],BccAddresses=[string,string]},ReplacementTags=[{Name=string,Value=string},{Name=string,Value=string}],ReplacementTemplateData=string ...

JSON Syntax:

[
  {
    "Destination": {
      "ToAddresses": ["string", ...],
      "CcAddresses": ["string", ...],
      "BccAddresses": ["string", ...]
    },
    "ReplacementTags": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "ReplacementTemplateData": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

Status -> (list)

The unique message identifier returned from the send-bulk-templated-email action.

(structure)

An object that contains the response from the send-bulk-templated-email operation.

Status -> (string)

The status of a message sent using the send-bulk-templated-email operation.

Possible values for this parameter include:

  • Success : Amazon SES accepted the message, and will attempt to deliver it to the recipients.
  • MessageRejected : The message was rejected because it contained a virus.
  • MailFromDomainNotVerified : The sender's email address or domain was not verified.
  • ConfigurationSetDoesNotExist : The configuration set you specified does not exist.
  • TemplateDoesNotExist : The template you specified does not exist.
  • AccountSuspended : Your account has been shut down because of issues related to your email sending practices.
  • AccountThrottled : The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
  • AccountDailyQuotaExceeded : You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
  • InvalidSendingPoolName : The configuration set you specified refers to an IP pool that does not exist.
  • AccountSendingPaused : Email sending for the Amazon SES account was disabled using the update-account-sending-enabled operation.
  • ConfigurationSetSendingPaused : Email sending for this configuration set was disabled using the update-configuration-set-sending-enabled operation.
  • InvalidParameterValue : One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
  • TransientFailure : Amazon SES was unable to process your request because of a temporary issue.
  • Failed : Amazon SES was unable to process your request. See the error message for additional information.

Error -> (string)

A description of an error that prevented a message being sent using the send-bulk-templated-email operation.

MessageId -> (string)

The unique message identifier returned from the send-bulk-templated-email operation.