Class SendTemplatedEmailCommandProtected

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

In order to send email using the SendTemplatedEmail 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 maximum message size is 10 MB.

• Calls to the SendTemplatedEmail 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.

If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.

For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { SESClient, SendTemplatedEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, SendTemplatedEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // SendTemplatedEmailRequest
  Source: "STRING_VALUE", // required
  Destination: { // Destination
    ToAddresses: [ // AddressList
      "STRING_VALUE",
    ],
    CcAddresses: [
      "STRING_VALUE",
    ],
    BccAddresses: [
      "STRING_VALUE",
    ],
  },
  ReplyToAddresses: [
    "STRING_VALUE",
  ],
  ReturnPath: "STRING_VALUE",
  SourceArn: "STRING_VALUE",
  ReturnPathArn: "STRING_VALUE",
  Tags: [ // MessageTagList
    { // MessageTag
      Name: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  ConfigurationSetName: "STRING_VALUE",
  Template: "STRING_VALUE", // required
  TemplateArn: "STRING_VALUE",
  TemplateData: "STRING_VALUE", // required
};
const command = new SendTemplatedEmailCommand(input);
const response = await client.send(command);

Param

SendTemplatedEmailCommandInput

Returns

SendTemplatedEmailCommandOutput

See

• SendTemplatedEmailCommandInput for command's input shape.
• SendTemplatedEmailCommandOutput for command's response shape.
• config for SESClient's config shape.

Throws

AccountSendingPausedException (client fault)

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.

Throws

ConfigurationSetDoesNotExistException (client fault)

Indicates that the configuration set does not exist.

Throws

ConfigurationSetSendingPausedException (client fault)

Indicates that email sending is disabled for the configuration set.

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

Throws

MailFromDomainNotVerifiedException (client fault)

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.

Throws

MessageRejected (client fault)

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

Throws

TemplateDoesNotExistException (client fault)

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