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.

Implementation 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

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.SimpleEmail.AmazonSimpleEmailServiceClient

Namespace: Amazon.SimpleEmail
Assembly: AWSSDK.SimpleEmail.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonSimpleEmailServiceClient : AmazonServiceClient
         IAmazonService, IAmazonSimpleEmailService, IDisposable

The AmazonSimpleEmailServiceClient type exposes the following members

Constructors

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



    
        
    

             

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



    
        
    

             

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



    
        
    

             

Public Method AmazonSimpleEmailServiceClient(AWSCredentials)

Constructs AmazonSimpleEmailServiceClient with AWS Credentials

Public Method AmazonSimpleEmailServiceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonSimpleEmailServiceClient with AWS Credentials

Public Method AmazonSimpleEmailServiceClient(AWSCredentials, AmazonSimpleEmailServiceConfig)

Constructs AmazonSimpleEmailServiceClient with AWS Credentials and an AmazonSimpleEmailServiceClient Configuration object.

Public Method AmazonSimpleEmailServiceClient(string, string)

Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleEmailServiceClient(string, string, RegionEndpoint)

Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleEmailServiceClient(string, string, AmazonSimpleEmailServiceConfig)

Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleEmailServiceClient Configuration object.

Public Method AmazonSimpleEmailServiceClient(string, string, string)

Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleEmailServiceClient(string, string, string, RegionEndpoint)

Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleEmailServiceClient(string, string, string, AmazonSimpleEmailServiceConfig)

Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleEmailServiceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

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.

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

Public Method CloneReceiptRuleSetAsync(CloneReceiptRuleSetRequest, CancellationToken)

Initiates the asynchronous execution of the CloneReceiptRuleSet operation.

Public Method CreateConfigurationSet(CreateConfigurationSetRequest)

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.

Public Method CreateConfigurationSetAsync(CreateConfigurationSetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConfigurationSet operation.

Public Method CreateConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest)

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.

Public Method CreateConfigurationSetEventDestinationAsync(CreateConfigurationSetEventDestinationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConfigurationSetEventDestination operation.

Public Method CreateConfigurationSetTrackingOptions(CreateConfigurationSetTrackingOptionsRequest)

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.

Public Method CreateConfigurationSetTrackingOptionsAsync(CreateConfigurationSetTrackingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConfigurationSetTrackingOptions 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.

You can execute this operation no more than once 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.

You can execute this operation no more than once 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.

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

Public Method CreateReceiptRuleSetAsync(CreateReceiptRuleSetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateReceiptRuleSet operation.

Public Method DeleteConfigurationSet(DeleteConfigurationSetRequest)

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.

Public Method DeleteConfigurationSetAsync(DeleteConfigurationSetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConfigurationSet operation.

Public Method DeleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest)

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.

Public Method DeleteConfigurationSetEventDestinationAsync(DeleteConfigurationSetEventDestinationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConfigurationSetEventDestination operation.

Public Method DeleteConfigurationSetTrackingOptions(DeleteConfigurationSetTrackingOptionsRequest)

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.

Public Method DeleteConfigurationSetTrackingOptionsAsync(DeleteConfigurationSetTrackingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConfigurationSetTrackingOptions operation.

Public Method DeleteIdentity(DeleteIdentityRequest)

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.

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

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.

You can execute this operation no more than once 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.

You can execute this operation no more than once 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.

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

Public Method DeleteReceiptRuleSetAsync(DeleteReceiptRuleSetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteReceiptRuleSet operation.

Public Method DeleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest)

Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.

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.

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

Public Method DescribeActiveReceiptRuleSetAsync(DescribeActiveReceiptRuleSetRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeActiveReceiptRuleSet operation.

Public Method DescribeConfigurationSet(DescribeConfigurationSetRequest)

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.

Public Method DescribeConfigurationSetAsync(DescribeConfigurationSetRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurationSet 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.

You can execute this operation no more than once 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.

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

Public Method DescribeReceiptRuleSetAsync(DescribeReceiptRuleSetRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeReceiptRuleSet operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetIdentityDkimAttributes(GetIdentityDkimAttributesRequest)

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.

Public Method GetIdentityDkimAttributesAsync(GetIdentityDkimAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetIdentityDkimAttributes operation.

Public Method GetIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest)

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.

Public Method GetIdentityMailFromDomainAttributesAsync(GetIdentityMailFromDomainAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetIdentityMailFromDomainAttributes operation.

Public Method GetIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest)

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.

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

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.

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.

Public Method GetIdentityVerificationAttributesAsync(GetIdentityVerificationAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetIdentityVerificationAttributes operation.

Public Method GetSendQuota()

Provides the sending limits for the Amazon SES account.

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

Public Method GetSendQuota(GetSendQuotaRequest)

Provides the sending limits for the Amazon SES account.

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

Public Method GetSendQuotaAsync(CancellationToken)

Provides the sending limits for the Amazon SES account.

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

Public Method GetSendQuotaAsync(GetSendQuotaRequest, CancellationToken)

Initiates the asynchronous execution of the GetSendQuota operation.

Public Method GetSendStatistics()

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.

Public Method GetSendStatistics(GetSendStatisticsRequest)

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.

Public Method GetSendStatisticsAsync(CancellationToken)

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.

Public Method GetSendStatisticsAsync(GetSendStatisticsRequest, CancellationToken)

Initiates the asynchronous execution of the GetSendStatistics operation.

Public Method ListConfigurationSets(ListConfigurationSetsRequest)

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.

Public Method ListConfigurationSetsAsync(ListConfigurationSetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListConfigurationSets operation.

Public Method ListIdentities()

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.

Public Method ListIdentities(ListIdentitiesRequest)

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.

Public Method ListIdentitiesAsync(CancellationToken)

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.

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

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

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.

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

Public Method ListReceiptRuleSetsAsync(ListReceiptRuleSetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListReceiptRuleSets operation.

Public Method ListVerifiedEmailAddresses()

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

Public Method ListVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest)

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

Public Method ListVerifiedEmailAddressesAsync(CancellationToken)

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

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

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.

You can execute this operation no more than once 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.

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

Public Method SendBounceAsync(SendBounceRequest, CancellationToken)

Initiates the asynchronous execution of the SendBounce operation.

Public Method SendEmail(SendEmailRequest)

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.

Public Method SendEmailAsync(SendEmailRequest, CancellationToken)

Initiates the asynchronous execution of the SendEmail operation.

Public Method SendRawEmail(SendRawEmailRequest)

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.

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.

You can execute this operation no more than once 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 (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.

Public Method SetIdentityDkimEnabledAsync(SetIdentityDkimEnabledRequest, CancellationToken)

Initiates the asynchronous execution of the SetIdentityDkimEnabled operation.

Public Method SetIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest)

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.

Public Method SetIdentityFeedbackForwardingEnabledAsync(SetIdentityFeedbackForwardingEnabledRequest, CancellationToken)

Initiates the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation.

Public Method SetIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest)

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.

Public Method SetIdentityHeadersInNotificationsEnabledAsync(SetIdentityHeadersInNotificationsEnabledRequest, CancellationToken)

Initiates the asynchronous execution of the SetIdentityHeadersInNotificationsEnabled operation.

Public Method SetIdentityMailFromDomain(SetIdentityMailFromDomainRequest)

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.

Public Method SetIdentityMailFromDomainAsync(SetIdentityMailFromDomainRequest, CancellationToken)

Initiates the asynchronous execution of the SetIdentityMailFromDomain operation.

Public Method SetIdentityNotificationTopic(SetIdentityNotificationTopicRequest)

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.

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.

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

Public Method SetReceiptRulePositionAsync(SetReceiptRulePositionRequest, CancellationToken)

Initiates the asynchronous execution of the SetReceiptRulePosition operation.

Public Method UpdateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest)

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.

Public Method UpdateConfigurationSetEventDestinationAsync(UpdateConfigurationSetEventDestinationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateConfigurationSetEventDestination operation.

Public Method UpdateConfigurationSetTrackingOptions(UpdateConfigurationSetTrackingOptionsRequest)

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.

Public Method UpdateConfigurationSetTrackingOptionsAsync(UpdateConfigurationSetTrackingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateConfigurationSetTrackingOptions operation.

Public Method UpdateReceiptRule(UpdateReceiptRuleRequest)

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.

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.

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.

Public Method VerifyDomainDkimAsync(VerifyDomainDkimRequest, CancellationToken)

Initiates the asynchronous execution of the VerifyDomainDkim operation.

Public Method VerifyDomainIdentity(VerifyDomainIdentityRequest)

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.

Public Method VerifyDomainIdentityAsync(VerifyDomainIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the VerifyDomainIdentity operation.

Public Method VerifyEmailAddress(VerifyEmailAddressRequest)

Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.

Public Method VerifyEmailAddressAsync(VerifyEmailAddressRequest, CancellationToken)

Initiates the asynchronous execution of the VerifyEmailAddress operation.

Public Method VerifyEmailIdentity(VerifyEmailIdentityRequest)

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.

Public Method VerifyEmailIdentityAsync(VerifyEmailIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the VerifyEmailIdentity operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone