AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

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

Class AlreadyExistsException

SimpleEmailService exception

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

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

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

Class CannotDeleteException

SimpleEmailService exception

Class CloneReceiptRuleSetRequest

Container for the parameters to the CloneReceiptRuleSet operation. Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

For information about setting up rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class CloneReceiptRuleSetResponse

An empty element returned on a successful request.

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

Class CloudWatchDimensionConfiguration

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

Class ConfigurationSet

The name of the configuration set.

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.

Class ConfigurationSetAlreadyExistsException

SimpleEmailService exception

Class ConfigurationSetDoesNotExistException

SimpleEmailService exception

Class Content

Represents textual data, plus an optional character set specification.

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.

Class CreateConfigurationSetEventDestinationRequest

Container for the parameters to the CreateConfigurationSetEventDestination operation. Creates a configuration set event destination.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class CreateConfigurationSetEventDestinationResponse

An empty element returned on a successful request.

Class CreateConfigurationSetRequest

Container for the parameters to the CreateConfigurationSet operation. Creates a configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class CreateConfigurationSetResponse

An empty element returned on a successful request.

Class CreateConfigurationSetTrackingOptionsRequest

Container for the parameters to the CreateConfigurationSetTrackingOptions operation. Creates an association between a configuration set and a custom domain for open and click event tracking.

By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Class CreateConfigurationSetTrackingOptionsResponse

An empty element returned on a successful request.

Class CreateReceiptFilterRequest

Container for the parameters to the CreateReceiptFilter operation. Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class CreateReceiptFilterResponse

An empty element returned on a successful request.

Class CreateReceiptRuleRequest

Container for the parameters to the CreateReceiptRule operation. Creates a receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class CreateReceiptRuleResponse

An empty element returned on a successful request.

Class CreateReceiptRuleSetRequest

Container for the parameters to the CreateReceiptRuleSet operation. Creates an empty receipt rule set.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class CreateReceiptRuleSetResponse

An empty element returned on a successful request.

Class DeleteConfigurationSetEventDestinationRequest

Container for the parameters to the DeleteConfigurationSetEventDestination operation. Deletes a configuration set event destination. Configuration set event destinations 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.

You can execute this operation no more than once per second.

Class DeleteConfigurationSetEventDestinationResponse

An empty element returned on a successful request.

Class DeleteConfigurationSetRequest

Container for the parameters to the DeleteConfigurationSet operation. Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DeleteConfigurationSetResponse

An empty element returned on a successful request.

Class DeleteConfigurationSetTrackingOptionsRequest

Container for the parameters to the DeleteConfigurationSetTrackingOptions operation. Deletes an association between a configuration set and a custom domain for open and click event tracking.

By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

Class DeleteConfigurationSetTrackingOptionsResponse

An empty element returned on a successful request.

Class DeleteIdentityPolicyRequest

Container for the parameters to the DeleteIdentityPolicy operation. Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DeleteIdentityPolicyResponse

An empty element returned on a successful request.

Class DeleteIdentityRequest

Container for the parameters to the DeleteIdentity operation. Deletes the specified identity (an email address or a domain) from the list of verified identities.

You can execute this operation no more than once per second.

Class DeleteIdentityResponse

An empty element returned on a successful request.

Class DeleteReceiptFilterRequest

Container for the parameters to the DeleteReceiptFilter operation. Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DeleteReceiptFilterResponse

An empty element returned on a successful request.

Class DeleteReceiptRuleRequest

Container for the parameters to the DeleteReceiptRule operation. Deletes the specified receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DeleteReceiptRuleResponse

An empty element returned on a successful request.

Class DeleteReceiptRuleSetRequest

Container for the parameters to the DeleteReceiptRuleSet operation. Deletes the specified receipt rule set and all of the receipt rules it contains.

The currently active rule set cannot be deleted.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DeleteReceiptRuleSetResponse

An empty element returned on a successful request.

Class DeleteVerifiedEmailAddressRequest

Container for the parameters to the DeleteVerifiedEmailAddress operation. Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.

Class DeleteVerifiedEmailAddressResponse

This is the response object from the DeleteVerifiedEmailAddress operation.

Class DescribeActiveReceiptRuleSetRequest

Container for the parameters to the DescribeActiveReceiptRuleSet operation. Returns the metadata and receipt rules for the receipt rule set that is currently active.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DescribeActiveReceiptRuleSetResponse

Represents the metadata and receipt rules for the receipt rule set that is currently active.

Class DescribeConfigurationSetRequest

Container for the parameters to the DescribeConfigurationSet operation. Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DescribeConfigurationSetResponse

Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Class DescribeReceiptRuleRequest

Container for the parameters to the DescribeReceiptRule operation. Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DescribeReceiptRuleResponse

Represents the details of a receipt rule.

Class DescribeReceiptRuleSetRequest

Container for the parameters to the DescribeReceiptRuleSet operation. Returns the details of the specified receipt rule set.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class DescribeReceiptRuleSetResponse

Represents the details of the specified receipt rule set.

Class Destination

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

Class EventDestination

Contains information about the event destination that the specified email sending events will be published to.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.

Class EventDestinationAlreadyExistsException

SimpleEmailService exception

Class EventDestinationDoesNotExistException

SimpleEmailService exception

Class ExtensionField

Additional X-headers 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.

Class GetIdentityDkimAttributesRequest

Container for the parameters to the GetIdentityDkimAttributes operation. Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This operation takes a list of identities as input and returns the following information for each:

  • Whether Easy DKIM signing is enabled or disabled.

  • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

  • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

Class GetIdentityDkimAttributesResponse

Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.

Class GetIdentityMailFromDomainAttributesRequest

Container for the parameters to the GetIdentityMailFromDomainAttributes operation. Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).

This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

Class GetIdentityMailFromDomainAttributesResponse

Represents the custom MAIL FROM attributes for a list of identities.

Class GetIdentityNotificationAttributesRequest

Container for the parameters to the GetIdentityNotificationAttributes operation. Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Class GetIdentityNotificationAttributesResponse

Represents the notification attributes for a list of identities.

Class GetIdentityPoliciesRequest

Container for the parameters to the GetIdentityPolicies operation. Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class GetIdentityPoliciesResponse

Represents the requested sending authorization policies.

Class GetIdentityVerificationAttributesRequest

Container for the parameters to the GetIdentityVerificationAttributes operation. Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning.

For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

Class GetIdentityVerificationAttributesResponse

The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

Class GetSendQuotaRequest

Container for the parameters to the GetSendQuota operation. Provides the sending limits for the Amazon SES account.

You can execute this operation no more than once per second.

Class GetSendQuotaResponse

Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.

Class GetSendStatisticsRequest

Container for the parameters to the GetSendStatistics operation. Provides sending statistics for the Amazon SES account. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.

You can execute this operation no more than once per second.

Class GetSendStatisticsResponse

Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.

Class IdentityDkimAttributes

Represents the DKIM attributes of a verified email address or a domain.

Class IdentityMailFromDomainAttributes

Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

Class IdentityNotificationAttributes

Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

Class IdentityVerificationAttributes

Represents the verification attributes of a single identity.

Class InvalidCloudWatchDestinationException

SimpleEmailService exception

Class InvalidConfigurationSetException

SimpleEmailService exception

Class InvalidFirehoseDestinationException

SimpleEmailService exception

Class InvalidLambdaFunctionException

SimpleEmailService exception

Class InvalidPolicyException

SimpleEmailService exception

Class InvalidS3ConfigurationException

SimpleEmailService exception

Class InvalidSNSDestinationException

SimpleEmailService exception

Class InvalidSnsTopicException

SimpleEmailService exception

Class InvalidTrackingOptionsException

SimpleEmailService exception

Class KinesisFirehoseDestination

Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Event destinations, such as Amazon Kinesis Firehose, 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.

Class LambdaAction

When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide.

Class LimitExceededException

SimpleEmailService exception

Class ListConfigurationSetsRequest

Container for the parameters to the ListConfigurationSets operation. Provides a list of the configuration sets associated with your Amazon SES account. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

You can execute this operation no more than once per second. This operation will return up to 50 configuration sets each time it is run. If your Amazon SES account has more than 50 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

Class ListConfigurationSetsResponse

A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Class ListIdentitiesRequest

Container for the parameters to the ListIdentities operation. Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

You can execute this operation no more than once per second.

Class ListIdentitiesResponse

A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.

Class ListIdentityPoliciesRequest

Container for the parameters to the ListIdentityPolicies operation. Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class ListIdentityPoliciesResponse

A list of names of sending authorization policies that apply to an identity.

Class ListReceiptFiltersRequest

Container for the parameters to the ListReceiptFilters operation. Lists the IP address filters associated with your AWS account.

For information about managing IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class ListReceiptFiltersResponse

A list of IP address filters that exist under your AWS account.

Class ListReceiptRuleSetsRequest

Container for the parameters to the ListReceiptRuleSets operation. Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class ListReceiptRuleSetsResponse

A list of receipt rule sets that exist under your AWS account.

Class ListVerifiedEmailAddressesRequest

Container for the parameters to the ListVerifiedEmailAddresses operation. Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.

Class ListVerifiedEmailAddressesResponse

A list of email addresses that you have verified with Amazon SES under your AWS account.

Class MailFromDomainNotVerifiedException

SimpleEmailService exception

Class Message

Represents the message to be sent, composed of a subject and a body.

Class MessageDsn

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

Class MessageRejectedException

SimpleEmailService exception

Class MessageTag

Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Class PutIdentityPolicyRequest

Container for the parameters to the PutIdentityPolicy operation. Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class PutIdentityPolicyResponse

An empty element returned on a successful request.

Class RawMessage

Represents the raw data of the message.

Class ReceiptAction

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Class ReceiptFilter

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

Class ReceiptIpFilter

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

Class ReceiptRule

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Class ReceiptRuleSetMetadata

Information about a receipt rule set.

A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

Class RecipientDsnFields

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.

Class ReorderReceiptRuleSetRequest

Container for the parameters to the ReorderReceiptRuleSet operation. Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class ReorderReceiptRuleSetResponse

An empty element returned on a successful request.

Class RuleDoesNotExistException

SimpleEmailService exception

Class RuleSetDoesNotExistException

SimpleEmailService exception

Class S3Action

When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that will bounce.

For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.

Class SendBounceRequest

Container for the parameters to the SendBounce operation. Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class SendBounceResponse

Represents a unique message ID.

Class SendDataPoint

Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.

Class SendEmailRequest

Container for the parameters to the SendEmail operation. Composes an email message and immediately queues it for sending. In order to send email using the SendEmail 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 will result 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 total size of the message, including attachments, must be smaller than 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 will be 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.

Class SendEmailResponse

Represents a unique message ID.

Class SendRawEmailRequest

Container for the parameters to the SendRawEmail operation. Composes an email message and immediately queues it for sending. When calling this operation, you may specify the message headers as well as the content. The SendRawEmail operation is particularly useful for sending multipart MIME emails (such as those that contain both a plain-text and an HTML version).

In order to send email using the SendRawEmail 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 will result 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 total size of the message, including attachments, must be smaller than 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 will be 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 SendRawEmail 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.

Additionally, keep the following considerations in mind when using the SendRawEmail operation:

  • Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.

  • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:

    • X-SES-SOURCE-ARN

    • X-SES-FROM-ARN

    • X-SES-RETURN-PATH-ARN

    Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.

    For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn parameter and not the FromIdentityArn or ReturnPathIdentityArn parameters. If you only specify the SourceIdentityArn parameter, Amazon SES will set the From and Return Path addresses to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.

Class SendRawEmailResponse

Represents a unique message ID.

Class SetActiveReceiptRuleSetRequest

Container for the parameters to the SetActiveReceiptRuleSet operation. Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class SetActiveReceiptRuleSetResponse

An empty element returned on a successful request.

Class SetIdentityDkimEnabledRequest

Container for the parameters to the SetIdentityDkimEnabled operation. Enables or disables Easy DKIM signing of email sent from an identity:

  • If Easy DKIM signing is enabled for a domain name identity (such as example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, user@example.com).

  • If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (for example, user@example.com), you can only enable Easy DKIM signing if the corresponding domain (in this case, example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim operation.

You can execute this operation no more than once per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

Class SetIdentityDkimEnabledResponse

An empty element returned on a successful request.

Class SetIdentityFeedbackForwardingEnabledRequest

Container for the parameters to the SetIdentityFeedbackForwardingEnabled operation. Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Class SetIdentityFeedbackForwardingEnabledResponse

An empty element returned on a successful request.

Class SetIdentityHeadersInNotificationsEnabledRequest

Container for the parameters to the SetIdentityHeadersInNotificationsEnabled operation. Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Class SetIdentityHeadersInNotificationsEnabledResponse

An empty element returned on a successful request.

Class SetIdentityMailFromDomainRequest

Container for the parameters to the SetIdentityMailFromDomain operation. Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class SetIdentityMailFromDomainResponse

An empty element returned on a successful request.

Class SetIdentityNotificationTopicRequest

Container for the parameters to the SetIdentityNotificationTopic operation. Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.

You can execute this operation no more than once per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

Class SetIdentityNotificationTopicResponse

An empty element returned on a successful request.

Class SetReceiptRulePositionRequest

Container for the parameters to the SetReceiptRulePosition operation. Sets the position of the specified receipt rule in the receipt rule set.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class SetReceiptRulePositionResponse

An empty element returned on a successful request.

Class SNSAction

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

Class SNSDestination

Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Event destinations, such as Amazon SNS, 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.

Class StopAction

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

Class TrackingOptions

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Class TrackingOptionsAlreadyExistsException

SimpleEmailService exception

Class TrackingOptionsDoesNotExistException

SimpleEmailService exception

Class UpdateConfigurationSetEventDestinationRequest

Container for the parameters to the UpdateConfigurationSetEventDestination operation. Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

You can execute this operation no more than once per second.

Class UpdateConfigurationSetEventDestinationResponse

An empty element returned on a successful request.

Class UpdateConfigurationSetTrackingOptionsRequest

Container for the parameters to the UpdateConfigurationSetTrackingOptions operation. Modifies an association between a configuration set and a custom domain for open and click event tracking.

By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Class UpdateConfigurationSetTrackingOptionsResponse

An empty element returned on a successful request.

Class UpdateReceiptRuleRequest

Container for the parameters to the UpdateReceiptRule operation. Updates a receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class UpdateReceiptRuleResponse

An empty element returned on a successful request.

Class VerifyDomainDkimRequest

Container for the parameters to the VerifyDomainDkim operation. Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.

You can execute this operation no more than once per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled operation.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

Class VerifyDomainDkimResponse

Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.

Class VerifyDomainIdentityRequest

Container for the parameters to the VerifyDomainIdentity operation. Adds a domain to the list of identities for your Amazon SES account and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Class VerifyDomainIdentityResponse

Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.

Class VerifyEmailAddressRequest

Container for the parameters to the VerifyEmailAddress operation. Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.

Class VerifyEmailAddressResponse

This is the response object from the VerifyEmailAddress operation.

Class VerifyEmailIdentityRequest

Container for the parameters to the VerifyEmailIdentity operation. Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address.

You can execute this operation no more than once per second.

Class VerifyEmailIdentityResponse

An empty element returned on a successful request.

Class WorkmailAction

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.