Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.simpleemail;
 
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 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.

 
 public interface AmazonSimpleEmailService {

    
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: "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 com.amazonaws.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.

Parameters:
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.
Throws:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

 
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

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

This action is throttled at one request per second.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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 using notifications with Amazon SES, see the Amazon SES Developer Guide .

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 .

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This action takes a list of identities as input and returns the following information for each:

  • Whether Easy DKIM signing is enabled or disabled.
  • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
  • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This action is throttled at one request per second.

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

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
verifyEmailAddressRequest Container for the necessary parameters to execute the VerifyEmailAddress service method on AmazonSimpleEmailService.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public void verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

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 .

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:
com.amazonaws.services.simpleemail.model.MessageRejectedException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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., user@example.com ).
  • If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (e.g., user@example.com ), 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 .

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Returns the user's current sending limits.

This action is throttled at one request per second.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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 .

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Verifies a domain.

This action is throttled at one request per second.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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 .

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:
com.amazonaws.services.simpleemail.model.MessageRejectedException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public SendEmailResult sendEmail(SendEmailRequest sendEmailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
deleteVerifiedEmailAddressRequest Container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method on AmazonSimpleEmailService.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
    public void deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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 .

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Returns:
The response from the ListVerifiedEmailAddresses service method, as returned by AmazonSimpleEmailService.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

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.

Returns:
The response from the GetSendStatistics service method, as returned by AmazonSimpleEmailService.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

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.

Returns:
The response from the ListIdentities service method, as returned by AmazonSimpleEmailService.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.

Returns the user's current sending limits.

This action is throttled at one request per second.

Returns:
The response from the GetSendQuota service method, as returned by AmazonSimpleEmailService.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleEmailService indicating either a problem with the data in the request, or a server side issue.
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.
    public void shutdown();
    
    
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.
}
        
New to GrepCode? Check out our FAQ X