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

Constructor Summary

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.

Method Summary

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.
GetSendQuotaResult	getSendQuota() Returns the user's current activity limits.
GetSendQuotaResult	getSendQuota(GetSendQuotaRequest getSendQuotaRequest) Returns the user's current activity limits.
GetSendStatisticsResult	getSendStatistics() Returns the user's sending statistics.
GetSendStatisticsResult	getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) Returns the user's sending statistics.
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	verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) Verifies an email address.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, shutdown

Methods inherited from class java.lang.Object

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

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

setEndpoint, shutdown

Constructor Detail

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

Method Detail

getSendQuota

public GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Returns the user's current activity limits.

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.

listVerifiedEmailAddresses

public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns a list containing all of the email addresses that have been verified.

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

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.

sendEmail

public 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. For more information, 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)
                                throws AmazonServiceException,
                                       AmazonClientException

Deletes the specified email address from the list of verified addresses.

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.

verifyEmailAddress

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

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)
                                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, with attachments or inline content. 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. For more information, go to 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.

getSendQuota

public GetSendQuotaResult getSendQuota()
                                throws AmazonServiceException,
                                       AmazonClientException

Returns the user's current activity limits.

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.

listVerifiedEmailAddresses

public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns a list containing all of the email addresses that have been verified.

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.

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.

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.