Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.simpleemail
Interface AmazonSimpleEmailService

All Known Subinterfaces:
AmazonSimpleEmailServiceAsync
All Known Implementing Classes:
AmazonSimpleEmailServiceAsyncClient, AmazonSimpleEmailServiceClient
public interface AmazonSimpleEmailService

Interface for accessing AmazonSimpleEmailService. 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 Getting Started Guide and the Amazon SES Developer Guide.

For specific details on how to construct a service request, please consult the Amazon SES Developer Guide .

NOTE:The endpoint for Amazon SES is located at: https://email.us-east-1.amazonaws.com

Method Summary
 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.
 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").
 void shutdown()
          Shuts down this client object, releasing any resources that might be held open.
 VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
           Verifies a domain.
 void verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
           Verifies an email address.
 VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
           Verifies an email address.
 

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException
Overrides the default endpoint for this client ("https://email.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Parameters:
endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
Throws:
IllegalArgumentException - If any problems are detected with the specified endpoint.

getSendQuota

GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Returns the user's current sending limits.

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.

deleteIdentity

DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

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

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.

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

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.

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

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.

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.

sendEmail

SendEmailResult sendEmail(SendEmailRequest sendEmailRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Composes an email message based on input data, and then immediately queues the message for sending.

IMPORTANT:If you have not yet requested production access to Amazon SES, then you will only be able to send email to and from verified email addresses and domains. 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 "Managing Your Sending Activity" section of the Amazon SES Developer Guide .

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.

verifyDomainIdentity

VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Verifies a domain.

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.

deleteVerifiedEmailAddress

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.

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.

verifyEmailAddress

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.

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

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:If you have not yet requested production access to Amazon SES, then you will only be able to send email to and from verified email addresses and domains. 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 "Managing Your Sending Activity" section of the Amazon SES Developer Guide .

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

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.

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

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.

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.

getSendQuota

GetSendQuotaResult getSendQuota()
                                throws AmazonServiceException,
                                       AmazonClientException

Returns the user's current sending limits.

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.

listVerifiedEmailAddresses

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.

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

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.

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

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.

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.

shutdown

void shutdown()
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:
request - The originally executed request.
Returns:
The response metadata for the specified request, or null if none is available.
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.