This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.
For specific details on how to construct a service request, please consult the Amazon SES Developer Guide.
NOTE:The endpoint for Amazon SES is located at: https://email.us-east-1.amazonaws.com
Inheritance Hierarchy
Amazon.Runtime.AbstractWebServiceClient
Amazon.Runtime.AmazonWebServiceClient
Amazon.SimpleEmail.AmazonSimpleEmailServiceClient
Namespace: Amazon.SimpleEmail
Assembly: AWSSDK.dll
Version: 2.0.0.3
Syntax
public class AmazonSimpleEmailServiceClient : AmazonWebServiceClient IAmazonSimpleEmailService, IDisposable
The AmazonSimpleEmailServiceClient type exposes the following members
Constructors
Name | Description | |
---|---|---|
![]() |
AmazonSimpleEmailServiceClient() |
Constructs AmazonSimpleEmailServiceClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
![]() |
AmazonSimpleEmailServiceClient(RegionEndpoint) |
Constructs AmazonSimpleEmailServiceClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
![]() |
AmazonSimpleEmailServiceClient(AmazonSimpleEmailServiceConfig) |
Constructs AmazonSimpleEmailServiceClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
![]() |
AmazonSimpleEmailServiceClient(AWSCredentials) | Constructs AmazonSimpleEmailServiceClient with AWS Credentials |
![]() |
AmazonSimpleEmailServiceClient(AWSCredentials, RegionEndpoint) | Constructs AmazonSimpleEmailServiceClient with AWS Credentials |
![]() |
AmazonSimpleEmailServiceClient(AWSCredentials, AmazonSimpleEmailServiceConfig) | Constructs AmazonSimpleEmailServiceClient with AWS Credentials and an AmazonSimpleEmailServiceClient Configuration object. |
![]() |
AmazonSimpleEmailServiceClient(string, string) | Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSimpleEmailServiceClient(string, string, RegionEndpoint) | Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSimpleEmailServiceClient(string, string, AmazonSimpleEmailServiceConfig) | Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleEmailServiceClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. |
![]() |
AmazonSimpleEmailServiceClient(string, string, string) | Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSimpleEmailServiceClient(string, string, string, RegionEndpoint) | Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSimpleEmailServiceClient(string, string, string, AmazonSimpleEmailServiceConfig) | Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleEmailServiceClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. |
Methods
Name | Description | |
---|---|---|
![]() |
DeleteIdentity(DeleteIdentityRequest) |
Deletes the specified identity (email address or domain) from the list of verified identities. This action is throttled at one request per second. |
![]() |
DeleteIdentityAsync(DeleteIdentityRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteIdentity operation.
|
![]() |
DeleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest) |
Deletes the specified email address from the list of verified addresses. IMPORTANT:The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred. This action is throttled at one request per second. |
![]() |
DeleteVerifiedEmailAddressAsync(DeleteVerifiedEmailAddressRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteVerifiedEmailAddress operation.
|
![]() |
Dispose() | Disposes of all managed and unmanaged resources. |
![]() |
GetIdentityDkimAttributes(GetIdentityDkimAttributesRequest) |
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action 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 action takes a list of identities as input and returns the following information for each:
This action is throttled at one request per second. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. |
![]() |
GetIdentityDkimAttributesAsync(GetIdentityDkimAttributesRequest, CancellationToken) |
Initiates the asynchronous execution of the GetIdentityDkimAttributes operation.
|
![]() |
GetIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest) |
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This action is throttled at one request per second. For more information about feedback notification, see the Amazon SES Developer Guide. |
![]() |
GetIdentityNotificationAttributesAsync(GetIdentityNotificationAttributesRequest, CancellationToken) |
Initiates the asynchronous execution of the GetIdentityNotificationAttributes operation.
|
![]() |
GetIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest) |
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. This action is throttled at one request per second. |
![]() |
GetIdentityVerificationAttributesAsync(GetIdentityVerificationAttributesRequest, CancellationToken) |
Initiates the asynchronous execution of the GetIdentityVerificationAttributes operation.
|
![]() |
GetSendQuota(GetSendQuotaRequest) |
Returns the user's current sending limits. This action is throttled at one request per second. |
![]() |
GetSendQuota() |
Returns the user's current sending limits. This action is throttled at one request per second. |
![]() |
GetSendQuotaAsync(GetSendQuotaRequest, CancellationToken) |
Initiates the asynchronous execution of the GetSendQuota operation.
|
![]() |
GetSendStatistics(GetSendStatisticsRequest) |
Returns the user's sending statistics. 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 interval. This action is throttled at one request per second. |
![]() |
GetSendStatistics() |
Returns the user's sending statistics. 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 interval. This action is throttled at one request per second. |
![]() |
GetSendStatisticsAsync(GetSendStatisticsRequest, CancellationToken) |
Initiates the asynchronous execution of the GetSendStatistics operation.
|
![]() |
ListIdentities(ListIdentitiesRequest) |
Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. This action is throttled at one request per second. |
![]() |
ListIdentities() |
Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. This action is throttled at one request per second. |
![]() |
ListIdentitiesAsync(ListIdentitiesRequest, CancellationToken) |
Initiates the asynchronous execution of the ListIdentities operation.
|
![]() |
ListVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest) |
Returns a list containing all of the email addresses that have been verified. IMPORTANT:The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred. This action is throttled at one request per second. |
![]() |
ListVerifiedEmailAddresses() |
Returns a list containing all of the email addresses that have been verified. IMPORTANT:The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred. This action is throttled at one request per second. |
![]() |
ListVerifiedEmailAddressesAsync(ListVerifiedEmailAddressesRequest, CancellationToken) |
Initiates the asynchronous execution of the ListVerifiedEmailAddresses operation.
|
![]() |
SendEmail(SendEmailRequest) |
Composes an email message based on input data, and then immediately queues the message for sending. IMPORTANT: You can only send email from verified email addresses and domains. If you have not requested production access to Amazon SES, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide. The total size of the message cannot exceed 10 MB. Amazon SES has a limit on the total number of recipients per message: The combined number of To:, CC: and BCC: email addresses cannot exceed 50. 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 Amazon SES repeatedly to send the message to each group. For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide. |
![]() |
SendEmailAsync(SendEmailRequest, CancellationToken) |
Initiates the asynchronous execution of the SendEmail operation.
|
![]() |
SendRawEmail(SendRawEmailRequest) |
Sends an email message, with header and content specified by the client. The IMPORTANT: You can only send email from verified email addresses and domains. If you have not requested production access to Amazon SES, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide. The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. Amazon SES has a limit on the total number of recipients per message: The combined number of To:, CC: and BCC: email addresses cannot exceed 50. 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 Amazon SES repeatedly to send the message to each group. For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide. |
![]() |
SendRawEmailAsync(SendRawEmailRequest, CancellationToken) |
Initiates the asynchronous execution of the SendRawEmail operation.
|
![]() |
SetIdentityDkimEnabled(SetIdentityDkimEnabledRequest) |
Enables or disables Easy DKIM signing of email sent from an identity:
For email addresses (e.g., This action is throttled at one request per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. |
![]() |
SetIdentityDkimEnabledAsync(SetIdentityDkimEnabledRequest, CancellationToken) |
Initiates the asynchronous execution of the SetIdentityDkimEnabled operation.
|
![]() |
SetIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest) |
Given an identity (email address or domain), enables or disables whether Amazon SES forwards feedback notifications as email. Feedback forwarding may only be disabled when both complaint and bounce topics are set. This action is throttled at one request per second. For more information about feedback notification, see the Amazon SES Developer Guide. |
![]() |
SetIdentityFeedbackForwardingEnabledAsync(SetIdentityFeedbackForwardingEnabledRequest, CancellationToken) |
Initiates the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation.
|
![]() |
SetIdentityNotificationTopic(SetIdentityNotificationTopicRequest) |
Given an identity (email address or domain), sets the Amazon SNS topic to which Amazon SES will publish bounce and complaint
notifications for emails sent with that identity as the This action is throttled at one request per second. For more information about feedback notification, see the Amazon SES Developer Guide. |
![]() |
SetIdentityNotificationTopicAsync(SetIdentityNotificationTopicRequest, CancellationToken) |
Initiates the asynchronous execution of the SetIdentityNotificationTopic operation.
|
![]() |
VerifyDomainDkim(VerifyDomainDkimRequest) |
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. This action is throttled at one request per second. To
enable or disable Easy DKIM signing for a domain, use the For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. |
![]() |
VerifyDomainDkimAsync(VerifyDomainDkimRequest, CancellationToken) |
Initiates the asynchronous execution of the VerifyDomainDkim operation.
|
![]() |
VerifyDomainIdentity(VerifyDomainIdentityRequest) |
Verifies a domain. This action is throttled at one request per second. |
![]() |
VerifyDomainIdentityAsync(VerifyDomainIdentityRequest, CancellationToken) |
Initiates the asynchronous execution of the VerifyDomainIdentity operation.
|
![]() |
VerifyEmailAddress(VerifyEmailAddressRequest) |
Verifies an email address. This action causes a confirmation email message to be sent to the specified address. IMPORTANT:The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred. This action is throttled at one request per second. |
![]() |
VerifyEmailAddressAsync(VerifyEmailAddressRequest, CancellationToken) |
Initiates the asynchronous execution of the VerifyEmailAddress operation.
|
![]() |
VerifyEmailIdentity(VerifyEmailIdentityRequest) |
Verifies an email address. This action causes a confirmation email message to be sent to the specified address. This action is throttled at one request per second. |
![]() |
VerifyEmailIdentityAsync(VerifyEmailIdentityRequest, CancellationToken) |
Initiates the asynchronous execution of the VerifyEmailIdentity operation.
|
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8
.NET for Windows Phone:
Supported in: Window Phone 8