The Amazon Simple Email Service API contains several data types that various actions use. This section describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• AddHeaderAction (p. 136)
• Body (p. 137)
• BounceAction (p. 138)
• BouncedRecipientInfo (p. 140)
• BulkEmailDestination (p. 141)
• BulkEmailDestinationStatus (p. 142)
• CloudWatchDestination (p. 144)
• CloudWatchDimensionConfiguration (p. 145)
• ConfigurationSet (p. 147)
• Content (p. 148)
• CustomVerificationEmailTemplate (p. 149)
• DeliveryOptions (p. 150)
• Destination (p. 151)
• EventDestination (p. 152)
• ExtensionField (p. 154)
• IdentityDkimAttributes (p. 155)
• IdentityMailFromDomainAttributes (p. 156)
• IdentityNotificationAttributes (p. 157)
• IdentityVerificationAttributes (p. 159)
• KinesisFirehoseDestination (p. 160)
• LambdaAction (p. 161)
• Message (p. 163)
• MessageDsn (p. 164)
• MessageTag (p. 165)
• RawMessage (p. 166)
• ReceiptAction (p. 167)
• ReceiptFilter (p. 169)
• ReceiptIpFilter (p. 170)
• ReceiptRule (p. 171)
• ReceiptRuleSetMetadata (p. 173)
• RecipientDsnFields (p. 174)
• ReputationOptions (p. 176)
• S3Action (p. 177)
• SendDataPoint (p. 179)
• SNSAction (p. 180)
• SNSDestination (p. 181)
• StopAction (p. 182)
• Template (p. 183)
• TemplateMetadata (p. 184)
• TrackingOptions (p. 185)
• WorkmailAction (p. 186)
AddHeaderAction
AddHeaderAction
When included in a receipt rule, this action adds a header to the received email.
For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.
Contents
HeaderName
The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
Type: String Required: Yes HeaderValue
The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Body
Body
Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.
Contents
Html
The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
Type: Content (p. 148) object Required: No
Text
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
Type: Content (p. 148) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BounceAction
BounceAction
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.
Contents
Message
Human-readable text to include in the bounce message.
Type: String Required: Yes Sender
The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
Type: String Required: Yes SmtpReplyCode
The SMTP reply code, as defined by RFC 5321.
Type: String Required: Yes StatusCode
The SMTP enhanced status code, as defined by RFC 3463.
Type: String Required: No TopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BouncedRecipientInfo
BouncedRecipientInfo
Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
Contents
BounceType
The reason for the bounce. You must provide either this parameter or RecipientDsnFields.
Type: String
Valid Values: DoesNotExist | MessageTooLarge | ExceededQuota | ContentRejected
| Undefined | TemporaryFailure Required: No
Recipient
The email address of the recipient of the bounced email.
Type: String Required: Yes RecipientArn
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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
Type: String Required: No RecipientDsnFields
Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.
Type: RecipientDsnFields (p. 174) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BulkEmailDestination
BulkEmailDestination
An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.
Contents
Destination
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination 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.
Type: Destination (p. 151) object Required: Yes
ReplacementTags.member.N
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
Type: Array of MessageTag (p. 165) objects Required: No
ReplacementTemplateData
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.
Type: String
Length Constraints: Maximum length of 262144.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BulkEmailDestinationStatus
BulkEmailDestinationStatus
An object that contains the response from the SendBulkTemplatedEmail operation.
Contents
Error
A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.
Type: String Required: No MessageId
The unique message identifier returned from the SendBulkTemplatedEmail operation.
Type: String Required: No Status
The status of a message sent using the SendBulkTemplatedEmail operation.
Possible values for this parameter include:
• Success: Amazon SES accepted the message, and attempts 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 UpdateAccountSendingEnabled (p. 114) operation.
• ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled (p. 119) 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.
Type: String
Valid Values: Success | MessageRejected | MailFromDomainNotVerified |
ConfigurationSetDoesNotExist | TemplateDoesNotExist | AccountSuspended |
See Also
AccountThrottled | AccountDailyQuotaExceeded | InvalidSendingPoolName | AccountSendingPaused | ConfigurationSetSendingPaused | InvalidParameterValue
| TransientFailure | Failed Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudWatchDestination
CloudWatchDestination
Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
Contents
DimensionConfigurations.member.N
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
Type: Array of CloudWatchDimensionConfiguration (p. 145) objects Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3