com.amazonaws.services.simpleemail

Class AmazonSimpleEmailServiceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.simpleemail.AmazonSimpleEmailServiceClient

All Implemented Interfaces:

AmazonSimpleEmailService

Direct Known Subclasses:

AmazonSimpleEmailServiceAsyncClient

public class AmazonSimpleEmailServiceClient
extends AmazonWebServiceClient
implements AmazonSimpleEmailService

Client for accessing AmazonSimpleEmailService. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all AmazonSimpleEmailService exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonSimpleEmailServiceClient() Constructs a new client to invoke service methods on AmazonSimpleEmailService.
AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials.
AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials and client configuration options.
AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials provider.
AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials provider and client configuration options.
AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonSimpleEmailServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonSimpleEmailService.

Method Summary

Methods

Modifier and Type	Method and Description
DeleteIdentityResult	deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) Deletes the specified identity (email address or domain) from the list of verified identities.
DeleteIdentityPolicyResult	deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (email address or domain).
void	deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) Deletes the specified email address from the list of verified addresses.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetIdentityDkimAttributesResult	getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) Returns the current status of Easy DKIM signing for an entity.
GetIdentityNotificationAttributesResult	getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
GetIdentityPoliciesResult	getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest) Returns the requested sending authorization policies for the given identity (email address or domain).
GetIdentityVerificationAttributesResult	getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest 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.
GetSendQuotaResult	getSendQuota() Returns the user's current sending limits.
GetSendQuotaResult	getSendQuota(GetSendQuotaRequest getSendQuotaRequest) Returns the user's current sending limits.
GetSendStatisticsResult	getSendStatistics() Returns the user's sending statistics.
GetSendStatisticsResult	getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) Returns the user's sending statistics.
ListIdentitiesResult	listIdentities() Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status.
ListIdentitiesResult	listIdentities(ListIdentitiesRequest listIdentitiesRequest) Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status.
ListIdentityPoliciesResult	listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (email address or domain).
ListVerifiedEmailAddressesResult	listVerifiedEmailAddresses() Returns a list containing all of the email addresses that have been verified.
ListVerifiedEmailAddressesResult	listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) Returns a list containing all of the email addresses that have been verified.
PutIdentityPolicyResult	putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (email address or domain).
SendEmailResult	sendEmail(SendEmailRequest sendEmailRequest) Composes an email message based on input data, and then immediately queues the message for sending.
SendRawEmailResult	sendRawEmail(SendRawEmailRequest sendRawEmailRequest) Sends an email message, with header and content specified by the client.
SetIdentityDkimEnabledResult	setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity:
SetIdentityFeedbackForwardingEnabledResult	setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.
SetIdentityNotificationTopicResult	setIdentityNotificationTopic(SetIdentityNotificationTopicRequest 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 .
VerifyDomainDkimResult	verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) Returns a set of DKIM tokens for a domain.
VerifyDomainIdentityResult	verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest) Verifies a domain.
void	verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) Verifies an email address.
VerifyEmailIdentityResult	verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest) Verifies an email address.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.simpleemail.AmazonSimpleEmailService

setEndpoint, setRegion, shutdown

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonSimpleEmailService exceptions.

Constructor Detail

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient()

Constructs a new client to invoke service methods on AmazonSimpleEmailService. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSimpleEmailService. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleEmailService (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleEmailService (ex: proxy settings, retry counts, etc.).

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleEmailService (ex: proxy settings, retry counts, etc.).

AmazonSimpleEmailServiceClient

public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonSimpleEmailService using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleEmailService (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

deleteIdentity

public DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)

Deletes the specified identity (email address or domain) from the list of verified identities.

This action is throttled at one request per second.

Specified by:

deleteIdentity in interface AmazonSimpleEmailService

Parameters:

deleteIdentityRequest - Container for the necessary parameters to execute the DeleteIdentity service method on AmazonSimpleEmailService.

Returns:

The response from the DeleteIdentity service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

listVerifiedEmailAddresses

public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest 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.

Specified by:

listVerifiedEmailAddresses in interface AmazonSimpleEmailService

Parameters:

listVerifiedEmailAddressesRequest - Container for the necessary parameters to execute the ListVerifiedEmailAddresses service method on AmazonSimpleEmailService.

Returns:

The response from the ListVerifiedEmailAddresses service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getSendStatistics

public GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest 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.

Specified by:

getSendStatistics in interface AmazonSimpleEmailService

Parameters:

getSendStatisticsRequest - Container for the necessary parameters to execute the GetSendStatistics service method on AmazonSimpleEmailService.

Returns:

The response from the GetSendStatistics service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

verifyEmailIdentity

public VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest 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.

Specified by:

verifyEmailIdentity in interface AmazonSimpleEmailService

Parameters:

verifyEmailIdentityRequest - Container for the necessary parameters to execute the VerifyEmailIdentity service method on AmazonSimpleEmailService.

Returns:

The response from the VerifyEmailIdentity service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getIdentityNotificationAttributes

public GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest 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 .

Specified by:

getIdentityNotificationAttributes in interface AmazonSimpleEmailService

Parameters:

getIdentityNotificationAttributesRequest - Container for the necessary parameters to execute the GetIdentityNotificationAttributes service method on AmazonSimpleEmailService.

Returns:

The response from the GetIdentityNotificationAttributes service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

verifyDomainDkim

public VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest 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 .

Specified by:

verifyDomainDkim in interface AmazonSimpleEmailService

Parameters:

verifyDomainDkimRequest - Container for the necessary parameters to execute the VerifyDomainDkim service method on AmazonSimpleEmailService.

Returns:

The response from the VerifyDomainDkim service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getIdentityDkimAttributes

public GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest 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 .

Specified by:

getIdentityDkimAttributes in interface AmazonSimpleEmailService

Parameters:

getIdentityDkimAttributesRequest - Container for the necessary parameters to execute the GetIdentityDkimAttributes service method on AmazonSimpleEmailService.

Returns:

The response from the GetIdentityDkimAttributes service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

listIdentityPolicies

public ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest 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 .

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

Specified by:

listIdentityPolicies in interface AmazonSimpleEmailService

Parameters:

listIdentityPoliciesRequest - Container for the necessary parameters to execute the ListIdentityPolicies service method on AmazonSimpleEmailService.

Returns:

The response from the ListIdentityPolicies service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

verifyEmailAddress

public void verifyEmailAddress(VerifyEmailAddressRequest 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.

Specified by:

verifyEmailAddress in interface AmazonSimpleEmailService

Parameters:

verifyEmailAddressRequest - Container for the necessary parameters to execute the VerifyEmailAddress service method on AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

sendRawEmail

public SendRawEmailResult sendRawEmail(SendRawEmailRequest 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

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

Specified by:

sendRawEmail in interface AmazonSimpleEmailService

Parameters:

sendRawEmailRequest - Container for the necessary parameters to execute the SendRawEmail service method on AmazonSimpleEmailService.

Returns:

The response from the SendRawEmail service method, as returned by AmazonSimpleEmailService.

Throws:

MessageRejectedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

listIdentities

public ListIdentitiesResult listIdentities(ListIdentitiesRequest 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.

Specified by:

listIdentities in interface AmazonSimpleEmailService

Parameters:

listIdentitiesRequest - Container for the necessary parameters to execute the ListIdentities service method on AmazonSimpleEmailService.

Returns:

The response from the ListIdentities service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getIdentityVerificationAttributes

public GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest 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.

Specified by:

getIdentityVerificationAttributes in interface AmazonSimpleEmailService

Parameters:

getIdentityVerificationAttributesRequest - Container for the necessary parameters to execute the GetIdentityVerificationAttributes service method on AmazonSimpleEmailService.

Returns:

The response from the GetIdentityVerificationAttributes service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

putIdentityPolicy

public PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)

Adds or updates a sending authorization policy for the specified identity (email address or domain).

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

Specified by:

putIdentityPolicy in interface AmazonSimpleEmailService

Parameters:

putIdentityPolicyRequest - Container for the necessary parameters to execute the PutIdentityPolicy service method on AmazonSimpleEmailService.

Returns:

The response from the PutIdentityPolicy service method, as returned by AmazonSimpleEmailService.

Throws:

InvalidPolicyException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getIdentityPolicies

public GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest 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.

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

Specified by:

getIdentityPolicies in interface AmazonSimpleEmailService

Parameters:

getIdentityPoliciesRequest - Container for the necessary parameters to execute the GetIdentityPolicies service method on AmazonSimpleEmailService.

Returns:

The response from the GetIdentityPolicies service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

setIdentityDkimEnabled

public SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest 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., [email protected] ).
• 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., [email protected] ), 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 .

Specified by:

setIdentityDkimEnabled in interface AmazonSimpleEmailService

Parameters:

setIdentityDkimEnabledRequest - Container for the necessary parameters to execute the SetIdentityDkimEnabled service method on AmazonSimpleEmailService.

Returns:

The response from the SetIdentityDkimEnabled service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getSendQuota

public GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)

Returns the user's current sending limits.

This action is throttled at one request per second.

Specified by:

getSendQuota in interface AmazonSimpleEmailService

Parameters:

getSendQuotaRequest - Container for the necessary parameters to execute the GetSendQuota service method on AmazonSimpleEmailService.

Returns:

The response from the GetSendQuota service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

deleteIdentityPolicy

public DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest 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.

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

Specified by:

deleteIdentityPolicy in interface AmazonSimpleEmailService

Parameters:

deleteIdentityPolicyRequest - Container for the necessary parameters to execute the DeleteIdentityPolicy service method on AmazonSimpleEmailService.

Returns:

The response from the DeleteIdentityPolicy service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

setIdentityFeedbackForwardingEnabled

public SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest 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.

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

Specified by:

setIdentityFeedbackForwardingEnabled in interface AmazonSimpleEmailService

Parameters:

setIdentityFeedbackForwardingEnabledRequest - Container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled service method on AmazonSimpleEmailService.

Returns:

The response from the SetIdentityFeedbackForwardingEnabled service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

verifyDomainIdentity

public VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)

Verifies a domain.

This action is throttled at one request per second.

Specified by:

verifyDomainIdentity in interface AmazonSimpleEmailService

Parameters:

verifyDomainIdentityRequest - Container for the necessary parameters to execute the VerifyDomainIdentity service method on AmazonSimpleEmailService.

Returns:

The response from the VerifyDomainIdentity service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

sendEmail

public SendEmailResult sendEmail(SendEmailRequest 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 .

Specified by:

sendEmail in interface AmazonSimpleEmailService

Parameters:

sendEmailRequest - Container for the necessary parameters to execute the SendEmail service method on AmazonSimpleEmailService.

Returns:

The response from the SendEmail service method, as returned by AmazonSimpleEmailService.

Throws:

MessageRejectedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

deleteVerifiedEmailAddress

public void deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest 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.

Specified by:

deleteVerifiedEmailAddress in interface AmazonSimpleEmailService

Parameters:

deleteVerifiedEmailAddressRequest - Container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method on AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

setIdentityNotificationTopic

public SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest 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 .

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

Specified by:

setIdentityNotificationTopic in interface AmazonSimpleEmailService

Parameters:

setIdentityNotificationTopicRequest - Container for the necessary parameters to execute the SetIdentityNotificationTopic service method on AmazonSimpleEmailService.

Returns:

The response from the SetIdentityNotificationTopic service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

listVerifiedEmailAddresses

public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Specified by:

listVerifiedEmailAddresses in interface AmazonSimpleEmailService

Returns:

The response from the ListVerifiedEmailAddresses service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getSendStatistics

public GetSendStatisticsResult getSendStatistics()
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

Specified by:

getSendStatistics in interface AmazonSimpleEmailService

Returns:

The response from the GetSendStatistics service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

listIdentities

public ListIdentitiesResult listIdentities()
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Specified by:

listIdentities in interface AmazonSimpleEmailService

Returns:

The response from the ListIdentities service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getSendQuota

public GetSendQuotaResult getSendQuota()
                                throws AmazonServiceException,
                                       AmazonClientException

Returns the user's current sending limits.

This action is throttled at one request per second.

Specified by:

getSendQuota in interface AmazonSimpleEmailService

Returns:

The response from the GetSendQuota service method, as returned by AmazonSimpleEmailService.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonSimpleEmailService

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.