AWS SDK for .NET Documentation
AmazonSimpleEmailServiceClient Class
AmazonAmazon.SimpleEmailAmazonSimpleEmailServiceClient Did this page help you?   Yes   No    Tell us about it...
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.

Note:
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
Declaration Syntax
C#
public class AmazonSimpleEmailServiceClient : AmazonWebServiceClient, 
	AmazonSimpleEmailService, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
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.
CopyC#
<?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.
CopyC#
<?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.
CopyC#
<?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.

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.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginDeleteIdentity(DeleteIdentityRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteIdentity operation.

BeginDeleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteVerifiedEmailAddress operation.

BeginGetIdentityDkimAttributes(GetIdentityDkimAttributesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetIdentityDkimAttributes operation.

BeginGetIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetIdentityNotificationAttributes operation.

BeginGetIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetIdentityVerificationAttributes operation.

BeginGetSendQuota(GetSendQuotaRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetSendQuota operation.

BeginGetSendStatistics(GetSendStatisticsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetSendStatistics operation.

BeginListIdentities(ListIdentitiesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListIdentities operation.

BeginListVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListVerifiedEmailAddresses operation.

BeginSendEmail(SendEmailRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SendEmail operation.

BeginSendRawEmail(SendRawEmailRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SendRawEmail operation.

BeginSetIdentityDkimEnabled(SetIdentityDkimEnabledRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetIdentityDkimEnabled operation.

BeginSetIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation.

BeginSetIdentityNotificationTopic(SetIdentityNotificationTopicRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetIdentityNotificationTopic operation.

BeginVerifyDomainDkim(VerifyDomainDkimRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the VerifyDomainDkim operation.

BeginVerifyDomainIdentity(VerifyDomainIdentityRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the VerifyDomainIdentity operation.

BeginVerifyEmailAddress(VerifyEmailAddressRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the VerifyEmailAddress operation.

BeginVerifyEmailIdentity(VerifyEmailIdentityRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the VerifyEmailIdentity operation.

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.


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.


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndDeleteIdentity(IAsyncResult)
Finishes the asynchronous execution of the DeleteIdentity operation.

EndDeleteVerifiedEmailAddress(IAsyncResult)
Finishes the asynchronous execution of the DeleteVerifiedEmailAddress operation.

EndGetIdentityDkimAttributes(IAsyncResult)
Finishes the asynchronous execution of the GetIdentityDkimAttributes operation.

EndGetIdentityNotificationAttributes(IAsyncResult)
Finishes the asynchronous execution of the GetIdentityNotificationAttributes operation.

EndGetIdentityVerificationAttributes(IAsyncResult)
Finishes the asynchronous execution of the GetIdentityVerificationAttributes operation.

EndGetSendQuota(IAsyncResult)
Finishes the asynchronous execution of the GetSendQuota operation.

EndGetSendStatistics(IAsyncResult)
Finishes the asynchronous execution of the GetSendStatistics operation.

EndListIdentities(IAsyncResult)
Finishes the asynchronous execution of the ListIdentities operation.

EndListVerifiedEmailAddresses(IAsyncResult)
Finishes the asynchronous execution of the ListVerifiedEmailAddresses operation.

EndSendEmail(IAsyncResult)
Finishes the asynchronous execution of the SendEmail operation.

EndSendRawEmail(IAsyncResult)
Finishes the asynchronous execution of the SendRawEmail operation.

EndSetIdentityDkimEnabled(IAsyncResult)
Finishes the asynchronous execution of the SetIdentityDkimEnabled operation.

EndSetIdentityFeedbackForwardingEnabled(IAsyncResult)
Finishes the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation.

EndSetIdentityNotificationTopic(IAsyncResult)
Finishes the asynchronous execution of the SetIdentityNotificationTopic operation.

EndVerifyDomainDkim(IAsyncResult)
Finishes the asynchronous execution of the VerifyDomainDkim operation.

EndVerifyDomainIdentity(IAsyncResult)
Finishes the asynchronous execution of the VerifyDomainIdentity operation.

EndVerifyEmailAddress(IAsyncResult)
Finishes the asynchronous execution of the VerifyEmailAddress operation.

EndVerifyEmailIdentity(IAsyncResult)
Finishes the asynchronous execution of the VerifyEmailIdentity operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
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.

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


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.


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.


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

This action is throttled at one request per second.


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

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.


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.


GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
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.


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.


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.


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.


SendEmail(SendEmailRequest)
Composes an email message based on input data, and then immediately queues the message for sending. 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.


SendRawEmail(SendRawEmailRequest)
Sends an email message, with header and content specified by the client. The
CopyC#
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. 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.


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.,
    CopyC#
    example.com
    ), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g.,
    CopyC#
    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.,

CopyC#
user@example.com
), you can only enable Easy DKIM signing if the corresponding domain (e.g.,
CopyC#
example.com
) has been set up for Easy DKIM using the AWS Console or the
CopyC#
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.


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.


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
CopyC#
Source
. Publishing to topics may only be disabled when feedback forwarding is enabled.

This action is throttled at one request per second.

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


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
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

CopyC#
SetIdentityDkimEnabled
action.

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


VerifyDomainIdentity(VerifyDomainIdentityRequest)
Verifies a domain.

This action is throttled at one request per second.


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.


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.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonSimpleEmailServiceClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)