Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class SendEmailCommandProtected

Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:

  • The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.

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

  • The message 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 is 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 SendEmail operation several times to send the message to each group.

For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

Example

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

import { SESClient, SendEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, SendEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // SendEmailRequest
Source: "STRING_VALUE", // required
Destination: { // Destination
ToAddresses: [ // AddressList
"STRING_VALUE",
],
CcAddresses: [
"STRING_VALUE",
],
BccAddresses: [
"STRING_VALUE",
],
},
Message: { // Message
Subject: { // Content
Data: "STRING_VALUE", // required
Charset: "STRING_VALUE",
},
Body: { // Body
Text: {
Data: "STRING_VALUE", // required
Charset: "STRING_VALUE",
},
Html: {
Data: "STRING_VALUE", // required
Charset: "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",
};
const command = new SendEmailCommand(input);
const response = await client.send(command);
// { // SendEmailResponse
// MessageId: "STRING_VALUE", // required
// };

Param

SendEmailCommandInput

Returns

SendEmailCommandOutput

See

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

SESServiceException

Base exception class for all service exceptions from SES service.

Example

SendEmail

// The following example sends a formatted email:
const input = {
"Destination": {
"BccAddresses": [],
"CcAddresses": [
"recipient3@example.com"
],
"ToAddresses": [
"recipient1@example.com",
"recipient2@example.com"
]
},
"Message": {
"Body": {
"Html": {
"Charset": "UTF-8",
"Data": "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>."
},
"Text": {
"Charset": "UTF-8",
"Data": "This is the message body in text format."
}
},
"Subject": {
"Charset": "UTF-8",
"Data": "Test email"
}
},
"ReplyToAddresses": [],
"ReturnPath": "",
"ReturnPathArn": "",
"Source": "sender@example.com",
"SourceArn": ""
};
const command = new SendEmailCommand(input);
const response = await client.send(command);
/* response ==
{
"MessageId": "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000"
}
*/
// example id: sendemail-1469049656296

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods