public interface AmazonSimpleEmailService
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.
Modifier and Type | Method and Description |
---|---|
DeleteIdentityResult |
deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (email address or domain) from the
list of verified identities.
|
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.
|
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.
|
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.
|
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.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://email.us-east-1.amazonaws.com").
|
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 feedback notifications as email.
|
SetIdentityNotificationTopicResult |
setIdentityNotificationTopic(SetIdentityNotificationTopicRequest 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
Source . |
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "email.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://email.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "email.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://email.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified identity (email address or domain) from the list of verified identities.
This action is throttled at one request per second.
deleteIdentityRequest
- Container for the necessary parameters to
execute the DeleteIdentity service method on AmazonSimpleEmailService.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.ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) 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.
listVerifiedEmailAddressesRequest
- Container for the necessary
parameters to execute the ListVerifiedEmailAddresses service method on
AmazonSimpleEmailService.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.GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) 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.
getSendStatisticsRequest
- Container for the necessary parameters
to execute the GetSendStatistics service method on
AmazonSimpleEmailService.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.VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest) throws AmazonServiceException, AmazonClientException
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.
verifyEmailIdentityRequest
- Container for the necessary
parameters to execute the VerifyEmailIdentity service method on
AmazonSimpleEmailService.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.GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) throws AmazonServiceException, AmazonClientException
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 .
getIdentityNotificationAttributesRequest
- Container for the
necessary parameters to execute the GetIdentityNotificationAttributes
service method on AmazonSimpleEmailService.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.VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) throws AmazonServiceException, AmazonClientException
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 .
verifyDomainDkimRequest
- Container for the necessary parameters
to execute the VerifyDomainDkim service method on
AmazonSimpleEmailService.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.GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This action takes a list of identities as input and returns the following information for each:
This action is throttled at one request per second.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide .
getIdentityDkimAttributesRequest
- Container for the necessary
parameters to execute the GetIdentityDkimAttributes service method on
AmazonSimpleEmailService.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.void verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) throws AmazonServiceException, AmazonClientException
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.
verifyEmailAddressRequest
- Container for the necessary
parameters to execute the VerifyEmailAddress service method on
AmazonSimpleEmailService.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.SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest) throws AmazonServiceException, AmazonClientException
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.
IMPORTANT: You can only send email from verified email addresses and domains. If you have not requested production access to Amazon SES, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
Amazon SES has a limit on the total number of recipients per message: The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide .
sendRawEmailRequest
- Container for the necessary parameters to
execute the SendRawEmail service method on AmazonSimpleEmailService.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.ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest) 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.
listIdentitiesRequest
- Container for the necessary parameters to
execute the ListIdentities service method on AmazonSimpleEmailService.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.GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest) throws AmazonServiceException, AmazonClientException
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.
getIdentityVerificationAttributesRequest
- Container for the
necessary parameters to execute the GetIdentityVerificationAttributes
service method on AmazonSimpleEmailService.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.SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) throws AmazonServiceException, AmazonClientException
Enables or disables Easy DKIM signing of email sent from an identity:
example.com
), then Amazon SES will DKIM-sign all email
sent by addresses under that domain name (e.g.,
[email protected]
).
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 .
setIdentityDkimEnabledRequest
- Container for the necessary
parameters to execute the SetIdentityDkimEnabled service method on
AmazonSimpleEmailService.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.GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest) throws AmazonServiceException, AmazonClientException
Returns the user's current sending limits.
This action is throttled at one request per second.
getSendQuotaRequest
- Container for the necessary parameters to
execute the GetSendQuota service method on AmazonSimpleEmailService.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.SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) throws AmazonServiceException, AmazonClientException
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 .
setIdentityFeedbackForwardingEnabledRequest
- Container for the
necessary parameters to execute the
SetIdentityFeedbackForwardingEnabled service method on
AmazonSimpleEmailService.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.VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest) throws AmazonServiceException, AmazonClientException
Verifies a domain.
This action is throttled at one request per second.
verifyDomainIdentityRequest
- Container for the necessary
parameters to execute the VerifyDomainIdentity service method on
AmazonSimpleEmailService.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.SendEmailResult sendEmail(SendEmailRequest sendEmailRequest) throws AmazonServiceException, AmazonClientException
Composes an email message based on input data, and then immediately queues the message for sending.
IMPORTANT: You can only send email from verified email addresses and domains. If you have not requested production access to Amazon SES, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
The total size of the message cannot exceed 10 MB.
Amazon SES has a limit on the total number of recipients per message: The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide .
sendEmailRequest
- Container for the necessary parameters to
execute the SendEmail service method on AmazonSimpleEmailService.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.void deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) throws AmazonServiceException, AmazonClientException
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.
deleteVerifiedEmailAddressRequest
- Container for the necessary
parameters to execute the DeleteVerifiedEmailAddress service method on
AmazonSimpleEmailService.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.SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) throws AmazonServiceException, AmazonClientException
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
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 .
setIdentityNotificationTopicRequest
- Container for the necessary
parameters to execute the SetIdentityNotificationTopic service method
on AmazonSimpleEmailService.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.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.
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.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.
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.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.
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.GetSendQuotaResult getSendQuota() throws AmazonServiceException, AmazonClientException
Returns the user's current sending limits.
This action is throttled at one request per second.
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request
- The originally executed request.Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.