Table Of Contents

Feedback

User Guide

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

[ aws . ses ]

send-templated-email

Description

Composes an email message using an email template and immediately queues it for sending.

In order to send email using the send-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.
  • Calls to the send-templated-email operation may only include one destination parameter. A destination is a set of recipients who will receive the same version of the email. The destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
  • The 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

See 'aws help' for descriptions of global parameters.

Synopsis

  send-templated-email
--source <value>
--destination <value>
[--reply-to-addresses <value>]
[--return-path <value>]
[--source-arn <value>]
[--return-path-arn <value>]
[--tags <value>]
[--configuration-set-name <value>]
--template <value>
[--template-arn <value>]
--template-data <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 .

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 <https://tools.ietf.org/html/rfc2047>`__ . MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= .

--destination (structure)

The destination for this email, composed of To:, CC:, and BCC: fields. A destination can include up to 50 recipients across these three fields.

Shorthand Syntax:

ToAddresses=string,string,CcAddresses=string,string,BccAddresses=string,string

JSON Syntax:

{
  "ToAddresses": ["string", ...],
  "CcAddresses": ["string", ...],
  "BccAddresses": ["string", ...]
}

--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.

--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 .

--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 .

--tags (list)

A list of tags, in the form of name/value pairs, to apply to an email that you send using send-templated-email . Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

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

--configuration-set-name (string)

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

--template (string)

The template to use when sending this email.

--template-arn (string)

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

--template-data (string)

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

--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.

See 'aws help' for descriptions of global parameters.

Output

MessageId -> (string)

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