AWS SDK Version 2 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.

.NET Framework 4.5
 
 
Interface for accessing SimpleEmailService Amazon Simple Email Service

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 a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

Inheritance Hierarchy

Amazon.SimpleEmail.IAmazonSimpleEmailService

Namespace: Amazon.SimpleEmail
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public interface IAmazonSimpleEmailService
         IDisposable

The IAmazonSimpleEmailService type exposes the following members

Methods

NameDescription
Public Method CloneReceiptRuleSet(CloneReceiptRuleSetRequest) 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.

This action is throttled at one request per second.

Public Method CloneReceiptRuleSetAsync(CloneReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the CloneReceiptRuleSet operation.
Public Method CreateReceiptFilter(CreateReceiptFilterRequest) Creates a new IP address filter.

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

This action is throttled at one request per second.

Public Method CreateReceiptFilterAsync(CreateReceiptFilterRequest, CancellationToken) Initiates the asynchronous execution of the CreateReceiptFilter operation.
Public Method CreateReceiptRule(CreateReceiptRuleRequest) Creates a receipt rule.

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

This action is throttled at one request per second.

Public Method CreateReceiptRuleAsync(CreateReceiptRuleRequest, CancellationToken) Initiates the asynchronous execution of the CreateReceiptRule operation.
Public Method CreateReceiptRuleSet(CreateReceiptRuleSetRequest) Creates an empty receipt rule set.

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

This action is throttled at one request per second.

Public Method CreateReceiptRuleSetAsync(CreateReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the CreateReceiptRuleSet operation.
Public Method 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.

Public Method DeleteIdentityAsync(DeleteIdentityRequest, CancellationToken) Initiates the asynchronous execution of the DeleteIdentity operation.
Public Method DeleteIdentityPolicy(DeleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (email address or 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.

This action is throttled at one request per second.

Public Method DeleteIdentityPolicyAsync(DeleteIdentityPolicyRequest, CancellationToken) Initiates the asynchronous execution of the DeleteIdentityPolicy operation.
Public Method DeleteReceiptFilter(DeleteReceiptFilterRequest) Deletes the specified IP address filter.

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

This action is throttled at one request per second.

Public Method DeleteReceiptFilterAsync(DeleteReceiptFilterRequest, CancellationToken) Initiates the asynchronous execution of the DeleteReceiptFilter operation.
Public Method DeleteReceiptRule(DeleteReceiptRuleRequest) Deletes the specified receipt rule.

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

This action is throttled at one request per second.

Public Method DeleteReceiptRuleAsync(DeleteReceiptRuleRequest, CancellationToken) Initiates the asynchronous execution of the DeleteReceiptRule operation.
Public Method DeleteReceiptRuleSet(DeleteReceiptRuleSetRequest) 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.

This action is throttled at one request per second.

Public Method DeleteReceiptRuleSetAsync(DeleteReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the DeleteReceiptRuleSet operation.
Public Method DeleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest) Deletes the specified email address from the list of verified addresses. 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.

Public Method DeleteVerifiedEmailAddressAsync(DeleteVerifiedEmailAddressRequest, CancellationToken) Initiates the asynchronous execution of the DeleteVerifiedEmailAddress operation.
Public Method DescribeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest) 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.

This action is throttled at one request per second.

Public Method DescribeActiveReceiptRuleSetAsync(DescribeActiveReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the DescribeActiveReceiptRuleSet operation.
Public Method DescribeReceiptRule(DescribeReceiptRuleRequest) Returns the details of the specified receipt rule.

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

This action is throttled at one request per second.

Public Method DescribeReceiptRuleAsync(DescribeReceiptRuleRequest, CancellationToken) Initiates the asynchronous execution of the DescribeReceiptRule operation.
Public Method DescribeReceiptRuleSet(DescribeReceiptRuleSetRequest) Returns the details of the specified receipt rule set.

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

This action is throttled at one request per second.

Public Method DescribeReceiptRuleSetAsync(DescribeReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the DescribeReceiptRuleSet operation.
Public Method 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:

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

Public Method GetIdentityDkimAttributesAsync(GetIdentityDkimAttributesRequest, CancellationToken) Initiates the asynchronous execution of the GetIdentityDkimAttributes operation.
Public Method 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 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.

Public Method GetIdentityNotificationAttributesAsync(GetIdentityNotificationAttributesRequest, CancellationToken) Initiates the asynchronous execution of the GetIdentityNotificationAttributes operation.
Public Method GetIdentityPolicies(GetIdentityPoliciesRequest) Returns the requested sending authorization policies for the given identity (email address or 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.

This action is throttled at one request per second.

Public Method GetIdentityPoliciesAsync(GetIdentityPoliciesRequest, CancellationToken) Initiates the asynchronous execution of the GetIdentityPolicies operation.
Public Method 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 and can only get verification attributes for up to 100 identities at a time.

Public Method GetIdentityVerificationAttributesAsync(GetIdentityVerificationAttributesRequest, CancellationToken) Initiates the asynchronous execution of the GetIdentityVerificationAttributes operation.
Public Method GetSendQuota() Returns the user's current sending limits.

This action is throttled at one request per second.

Public Method GetSendQuota(GetSendQuotaRequest) Returns the user's current sending limits.

This action is throttled at one request per second.

Public Method GetSendQuotaAsync(GetSendQuotaRequest, CancellationToken) Initiates the asynchronous execution of the GetSendQuota operation.
Public Method 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.

Public Method 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.

Public Method GetSendStatisticsAsync(GetSendStatisticsRequest, CancellationToken) Initiates the asynchronous execution of the GetSendStatistics operation.
Public Method 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.

Public Method 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.

Public Method ListIdentitiesAsync(ListIdentitiesRequest, CancellationToken) Initiates the asynchronous execution of the ListIdentities operation.
Public Method ListIdentityPolicies(ListIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (email address or 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.

This action is throttled at one request per second.

Public Method ListIdentityPoliciesAsync(ListIdentityPoliciesRequest, CancellationToken) Initiates the asynchronous execution of the ListIdentityPolicies operation.
Public Method ListReceiptFilters(ListReceiptFiltersRequest) Lists the IP address filters associated with your account.

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

This action is throttled at one request per second.

Public Method ListReceiptFiltersAsync(ListReceiptFiltersRequest, CancellationToken) Initiates the asynchronous execution of the ListReceiptFilters operation.
Public Method ListReceiptRuleSets(ListReceiptRuleSetsRequest) 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.

This action is throttled at one request per second.

Public Method ListReceiptRuleSetsAsync(ListReceiptRuleSetsRequest, CancellationToken) Initiates the asynchronous execution of the ListReceiptRuleSets operation.
Public Method ListVerifiedEmailAddresses() Returns a list containing all of the email addresses that have been verified. 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.

Public Method ListVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest) Returns a list containing all of the email addresses that have been verified. 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.

Public Method ListVerifiedEmailAddressesAsync(ListVerifiedEmailAddressesRequest, CancellationToken) Initiates the asynchronous execution of the ListVerifiedEmailAddresses operation.
Public Method PutIdentityPolicy(PutIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (email address or 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.

This action is throttled at one request per second.

Public Method PutIdentityPolicyAsync(PutIdentityPolicyRequest, CancellationToken) Initiates the asynchronous execution of the PutIdentityPolicy operation.
Public Method ReorderReceiptRuleSet(ReorderReceiptRuleSetRequest) 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.

This action is throttled at one request per second.

Public Method ReorderReceiptRuleSetAsync(ReorderReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the ReorderReceiptRuleSet operation.
Public Method SendBounce(SendBounceRequest) 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.

This action is throttled at one request per second.

Public Method SendBounceAsync(SendBounceRequest, CancellationToken) Initiates the asynchronous execution of the SendBounce operation.
Public Method SendEmail(SendEmailRequest) Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, 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.
Public Method SendEmailAsync(SendEmailRequest, CancellationToken) Initiates the asynchronous execution of the SendEmail operation.
Public Method SendRawEmail(SendRawEmailRequest) Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.

There are several important points to know about SendRawEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, 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.
  • The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.
  • 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.
  • 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, because they are removed by Amazon SES before sending the email. For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.
Public Method SendRawEmailAsync(SendRawEmailRequest, CancellationToken) Initiates the asynchronous execution of the SendRawEmail operation.
Public Method SetActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest) 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.

This action is throttled at one request per second.

Public Method SetActiveReceiptRuleSetAsync(SetActiveReceiptRuleSetRequest, CancellationToken) Initiates the asynchronous execution of the SetActiveReceiptRuleSet operation.
Public Method SetIdentityDkimEnabled(SetIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity:
  • If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., 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 (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.

This action is throttled at one request per second.

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

Public Method SetIdentityDkimEnabledAsync(SetIdentityDkimEnabledRequest, CancellationToken) Initiates the asynchronous execution of the SetIdentityDkimEnabled operation.
Public Method SetIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest) Given an identity (email address or 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.

This action is throttled at one request per second.

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

Public Method SetIdentityFeedbackForwardingEnabledAsync(SetIdentityFeedbackForwardingEnabledRequest, CancellationToken) Initiates the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation.
Public Method SetIdentityNotificationTopic(SetIdentityNotificationTopicRequest) Given an identity (email address or 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.

This action is throttled at one request per second.

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

Public Method SetIdentityNotificationTopicAsync(SetIdentityNotificationTopicRequest, CancellationToken) Initiates the asynchronous execution of the SetIdentityNotificationTopic operation.
Public Method SetReceiptRulePosition(SetReceiptRulePositionRequest) 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.

This action is throttled at one request per second.

Public Method SetReceiptRulePositionAsync(SetReceiptRulePositionRequest, CancellationToken) Initiates the asynchronous execution of the SetReceiptRulePosition operation.
Public Method UpdateReceiptRule(UpdateReceiptRuleRequest) Updates a receipt rule.

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

This action is throttled at one request per second.

Public Method UpdateReceiptRuleAsync(UpdateReceiptRuleRequest, CancellationToken) Initiates the asynchronous execution of the UpdateReceiptRule operation.
Public Method 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 SetIdentityDkimEnabled action.

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

Public Method VerifyDomainDkimAsync(VerifyDomainDkimRequest, CancellationToken) Initiates the asynchronous execution of the VerifyDomainDkim operation.
Public Method VerifyDomainIdentity(VerifyDomainIdentityRequest) Verifies a domain.

This action is throttled at one request per second.

Public Method VerifyDomainIdentityAsync(VerifyDomainIdentityRequest, CancellationToken) Initiates the asynchronous execution of the VerifyDomainIdentity operation.
Public Method VerifyEmailAddress(VerifyEmailAddressRequest) Verifies an email address. This action causes a confirmation email message to be sent to the specified address. 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.

Public Method VerifyEmailAddressAsync(VerifyEmailAddressRequest, CancellationToken) Initiates the asynchronous execution of the VerifyEmailAddress operation.
Public Method 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.

Public Method VerifyEmailIdentityAsync(VerifyEmailIdentityRequest, CancellationToken) Initiates the asynchronous execution of the VerifyEmailIdentity operation.

Examples

This example shows how to send an email.

Send email example

var sesClient = new AmazonSimpleEmailServiceClient();           
      
var dest = new Destination
{
  ToAddresses = new List<string>() { "janedoe@example.com" },
  CcAddresses = new List<string>() { "richarddoe@example.com" }
};

var from = "johndoe@example.com";
var subject = new Content("You're invited to the meeting");
var body = new Body(new Content("Please join us Monday at 7:00 PM."));
var msg = new Message(subject, body);

var request = new SendEmailRequest
{
  Destination = dest,
  Message = msg, 
  Source = from
};

sesClient.SendEmail(request);

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8