class Aws::SES::Types::SendTemplatedEmailRequest

Represents a request to send a templated email using Amazon SES. For more information, see the [Amazon SES Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html

@note When making an API call, you may pass SendTemplatedEmailRequest

data as a hash:

    {
      source: "Address", # required
      destination: { # required
        to_addresses: ["Address"],
        cc_addresses: ["Address"],
        bcc_addresses: ["Address"],
      },
      reply_to_addresses: ["Address"],
      return_path: "Address",
      source_arn: "AmazonResourceName",
      return_path_arn: "AmazonResourceName",
      tags: [
        {
          name: "MessageTagName", # required
          value: "MessageTagValue", # required
        },
      ],
      configuration_set_name: "ConfigurationSetName",
      template: "TemplateName", # required
      template_arn: "AmazonResourceName",
      template_data: "TemplateData", # required
    }

@!attribute [rw] 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][1].

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][2].

<note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
[RFC6531][3]. 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][4]. 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][5].
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][6]. MIME encoded-word
syntax uses the following form: `=?charset?encoding?encoded-text?=`.

 </note>

[1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
[2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
[3]: https://tools.ietf.org/html/rfc6531
[4]: https://en.wikipedia.org/wiki/Email_address#Local-part
[5]: https://tools.ietf.org/html/rfc3492.html
[6]: https://tools.ietf.org/html/rfc2047
@return [String]

@!attribute [rw] destination

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

@!attribute [rw] reply_to_addresses

The reply-to email address(es) for the message. If the recipient
replies to the message, each reply-to address will receive the
reply.
@return [Array<String>]

@!attribute [rw] return_path

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 [String]

@!attribute [rw] source_arn

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][1].

[1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
@return [String]

@!attribute [rw] return_path_arn

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][1].

[1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
@return [String]

@!attribute [rw] tags

A list of tags, in the form of name/value pairs, to apply to an
email that you send using `SendTemplatedEmail`. Tags correspond to
characteristics of the email that you define, so that you can
publish email sending events.
@return [Array<Types::MessageTag>]

@!attribute [rw] configuration_set_name

The name of the configuration set to use when you send an email
using `SendTemplatedEmail`.
@return [String]

@!attribute [rw] template

The template to use when sending this email.
@return [String]

@!attribute [rw] template_arn

The ARN of the template to use when sending this email.
@return [String]

@!attribute [rw] template_data

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendTemplatedEmailRequest AWS API Documentation

Constants

SENSITIVE