/*
* Copyright 2010-2020 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;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.simpleemail.model.*;
/**
* Interface for accessing Amazon Simple Email Service
* This document contains reference information for the Amazon Simple Email Service (Amazon * SES) API, version 2010-12-01. This document is best used in conjunction with * the Amazon SES Developer Guide. *
** For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide. *
** 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 * {@link 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. * * @param 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 IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AmazonSimpleEmailService#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 {@link 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. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *
* Creates a receipt rule set by cloning an existing one. All receipt rules * and configurations are copied to the new receipt rule set and are * completely independent of the source rule set. *
** For information about setting up rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param cloneReceiptRuleSetRequest* Represents a request to create a receipt rule set by cloning * an existing one. You use receipt rule sets to receive email * with Amazon SES. For more information, see the Amazon SES Developer Guide. *
* @return cloneReceiptRuleSetResult The response from the * CloneReceiptRuleSet service method, as returned by Amazon Simple * Email Service. * @throws RuleSetDoesNotExistException * @throws AlreadyExistsException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CloneReceiptRuleSetResult cloneReceiptRuleSet( CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a configuration set. *
** Configuration sets enable you to publish email sending events. For * information about using configuration sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createConfigurationSetRequest* Represents a request to create a configuration set. * Configuration sets enable you to publish email sending events. * For information about using configuration sets, see the Amazon SES Developer Guide. *
* @return createConfigurationSetResult The response from the * CreateConfigurationSet service method, as returned by Amazon * Simple Email Service. * @throws ConfigurationSetAlreadyExistsException * @throws InvalidConfigurationSetException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateConfigurationSetResult createConfigurationSet( CreateConfigurationSetRequest createConfigurationSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a configuration set event destination. *
** When you create or update an event destination, you must provide one, and * only one, destination. The destination can be CloudWatch, Amazon Kinesis * Firehose, or Amazon Simple Notification Service (Amazon SNS). *
** An event destination is the AWS service to which Amazon SES publishes the * email sending events associated with a configuration set. For information * about using configuration sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createConfigurationSetEventDestinationRequest* Represents a request to create a configuration set event * destination. A configuration set event destination, which can * be either Amazon CloudWatch or Amazon Kinesis Firehose, * describes an AWS service in which Amazon SES publishes the * email sending events associated with a configuration set. For * information about using configuration sets, see the Amazon SES Developer Guide. *
* @return createConfigurationSetEventDestinationResult The response from * the CreateConfigurationSetEventDestination service method, as * returned by Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws EventDestinationAlreadyExistsException * @throws InvalidCloudWatchDestinationException * @throws InvalidFirehoseDestinationException * @throws InvalidSNSDestinationException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination( CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates an association between a configuration set and a custom domain * for open and click event tracking. *
** By default, images and links used for tracking open and click events are * hosted on domains operated by Amazon SES. You can configure a subdomain * of your own to handle these events. For information about using custom * domains, see the Amazon SES Developer Guide. *
* * @param createConfigurationSetTrackingOptionsRequest* Represents a request to create an open and click tracking * option object in a configuration set. *
* @return createConfigurationSetTrackingOptionsResult The response from the * CreateConfigurationSetTrackingOptions service method, as returned * by Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws TrackingOptionsAlreadyExistsException * @throws InvalidTrackingOptionsException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateConfigurationSetTrackingOptionsResult createConfigurationSetTrackingOptions( CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a new custom verification email template. *
** For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES * Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createCustomVerificationEmailTemplateRequest* Represents a request to create a custom verification email * template. *
* @throws CustomVerificationEmailTemplateAlreadyExistsException * @throws FromEmailAddressNotVerifiedException * @throws CustomVerificationEmailInvalidContentException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void createCustomVerificationEmailTemplate( CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a new IP address filter. *
** For information about setting up IP address filters, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createReceiptFilterRequest* Represents a request to create a new IP address filter. You * use IP address filters when you receive email with Amazon SES. * For more information, see the Amazon SES Developer Guide. *
* @return createReceiptFilterResult The response from the * CreateReceiptFilter service method, as returned by Amazon Simple * Email Service. * @throws LimitExceededException * @throws AlreadyExistsException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateReceiptFilterResult createReceiptFilter( CreateReceiptFilterRequest createReceiptFilterRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a receipt rule. *
** For information about setting up receipt rules, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createReceiptRuleRequest* Represents a request to create a receipt rule. You use receipt * rules to receive email with Amazon SES. For more information, * see the Amazon SES Developer Guide. *
* @return createReceiptRuleResult The response from the CreateReceiptRule * service method, as returned by Amazon Simple Email Service. * @throws InvalidSnsTopicException * @throws InvalidS3ConfigurationException * @throws InvalidLambdaFunctionException * @throws AlreadyExistsException * @throws RuleDoesNotExistException * @throws RuleSetDoesNotExistException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates an empty receipt rule set. *
** For information about setting up receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createReceiptRuleSetRequest* Represents a request to create an empty receipt rule set. You * use receipt rule sets to receive email with Amazon SES. For * more information, see the Amazon SES Developer Guide. *
* @return createReceiptRuleSetResult The response from the * CreateReceiptRuleSet service method, as returned by Amazon Simple * Email Service. * @throws AlreadyExistsException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateReceiptRuleSetResult createReceiptRuleSet( CreateReceiptRuleSetRequest createReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates an email template. Email templates enable you to send * personalized email to one or more destinations in a single API operation. * For more information, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param createTemplateRequest* Represents a request to create an email template. For more * information, see the Amazon SES Developer Guide. *
* @return createTemplateResult The response from the CreateTemplate service * method, as returned by Amazon Simple Email Service. * @throws AlreadyExistsException * @throws InvalidTemplateException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a configuration set. Configuration sets enable you to publish * email sending events. For information about using configuration sets, see * the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteConfigurationSetRequest* Represents a request to delete a configuration set. * Configuration sets enable you to publish email sending events. * For information about using configuration sets, see the Amazon SES Developer Guide. *
* @return deleteConfigurationSetResult The response from the * DeleteConfigurationSet service method, as returned by Amazon * Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteConfigurationSetResult deleteConfigurationSet( DeleteConfigurationSetRequest deleteConfigurationSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a configuration set event destination. Configuration set event * destinations are associated with configuration sets, which enable you to * publish email sending events. For information about using configuration * sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteConfigurationSetEventDestinationRequest* Represents a request to delete a configuration set event * destination. Configuration set event destinations are * associated with configuration sets, which enable you to * publish email sending events. For information about using * configuration sets, see the Amazon SES Developer Guide. *
* @return deleteConfigurationSetEventDestinationResult The response from * the DeleteConfigurationSetEventDestination service method, as * returned by Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws EventDestinationDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination( DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes an association between a configuration set and a custom domain * for open and click event tracking. *
** By default, images and links used for tracking open and click events are * hosted on domains operated by Amazon SES. You can configure a subdomain * of your own to handle these events. For information about using custom * domains, see the Amazon SES Developer Guide. *
** Deleting this kind of association will result in emails sent using the * specified configuration set to capture open and click events using the * standard, Amazon SES-operated domains. *
** Represents a request to delete open and click tracking options * in a configuration set. *
* @return deleteConfigurationSetTrackingOptionsResult The response from the * DeleteConfigurationSetTrackingOptions service method, as returned * by Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws TrackingOptionsDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteConfigurationSetTrackingOptionsResult deleteConfigurationSetTrackingOptions( DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes an existing custom verification email template. *
** For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES * Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteCustomVerificationEmailTemplateRequest* Represents a request to delete an existing custom verification * email template. *
* @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void deleteCustomVerificationEmailTemplate( DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified identity (an email address or a domain) from the * list of verified identities. *
** You can execute this operation no more than once per second. *
* * @param deleteIdentityRequest* Represents a request to delete one of your Amazon SES * identities (an email address or domain). *
* @return deleteIdentityResult The response from the DeleteIdentity service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified sending authorization policy for the given identity * (an email address or a domain). This API returns successfully even if a * policy with the specified name does not exist. *
** This API is for the identity owner only. If you have not verified the * identity, this API will return an error. *
** Sending authorization is a feature that enables an identity owner to * authorize other senders to use its identities. For information about * using sending authorization, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteIdentityPolicyRequest* Represents a request to delete a sending authorization policy * for an identity. Sending authorization is an Amazon SES * feature that enables you to authorize other senders to use * your identities. For information, see the Amazon SES Developer Guide. *
* @return deleteIdentityPolicyResult The response from the * DeleteIdentityPolicy service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteIdentityPolicyResult deleteIdentityPolicy( DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified IP address filter. *
** For information about managing IP address filters, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteReceiptFilterRequest* Represents a request to delete an IP address filter. You use * IP address filters when you receive email with Amazon SES. For * more information, see the Amazon SES Developer Guide. *
* @return deleteReceiptFilterResult The response from the * DeleteReceiptFilter service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteReceiptFilterResult deleteReceiptFilter( DeleteReceiptFilterRequest deleteReceiptFilterRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified receipt rule. *
** For information about managing receipt rules, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteReceiptRuleRequest* Represents a request to delete a receipt rule. You use receipt * rules to receive email with Amazon SES. For more information, * see the Amazon SES Developer Guide. *
* @return deleteReceiptRuleResult The response from the DeleteReceiptRule * service method, as returned by Amazon Simple Email Service. * @throws RuleSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified receipt rule set and all of the receipt rules it * contains. *
** The currently active rule set cannot be deleted. *
** For information about managing receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param deleteReceiptRuleSetRequest* Represents a request to delete a receipt rule set and all of * the receipt rules it contains. You use receipt rule sets to * receive email with Amazon SES. For more information, see the * Amazon SES Developer Guide. *
* @return deleteReceiptRuleSetResult The response from the * DeleteReceiptRuleSet service method, as returned by Amazon Simple * Email Service. * @throws CannotDeleteException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteReceiptRuleSetResult deleteReceiptRuleSet( DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes an email template. *
** You can execute this operation no more than once per second. *
* * @param deleteTemplateRequest* Represents a request to delete an email template. For more * information, see the Amazon SES Developer Guide. *
* @return deleteTemplateResult The response from the DeleteTemplate service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) throws AmazonClientException, AmazonServiceException; /** *
* Deprecated. Use the DeleteIdentity
operation to delete email
* addresses and domains.
*
* Represents a request to delete an email address from the list * of email addresses you have attempted to verify under your AWS * account. *
* @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void deleteVerifiedEmailAddress( DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the metadata and receipt rules for the receipt rule set that is * currently active. *
** For information about setting up receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param describeActiveReceiptRuleSetRequest* Represents a request to return the metadata and receipt rules * for the receipt rule set that is currently active. You use * receipt rule sets to receive email with Amazon SES. For more * information, see the Amazon SES Developer Guide. *
* @return describeActiveReceiptRuleSetResult The response from the * DescribeActiveReceiptRuleSet service method, as returned by * Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet( DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the details of the specified configuration set. For information * about using configuration sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param describeConfigurationSetRequest* Represents a request to return the details of a configuration * set. Configuration sets enable you to publish email sending * events. For information about using configuration sets, see * the Amazon SES Developer Guide. *
* @return describeConfigurationSetResult The response from the * DescribeConfigurationSet service method, as returned by Amazon * Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DescribeConfigurationSetResult describeConfigurationSet( DescribeConfigurationSetRequest describeConfigurationSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the details of the specified receipt rule. *
** For information about setting up receipt rules, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param describeReceiptRuleRequest* Represents a request to return the details of a receipt rule. * You use receipt rules to receive email with Amazon SES. For * more information, see the Amazon SES Developer Guide. *
* @return describeReceiptRuleResult The response from the * DescribeReceiptRule service method, as returned by Amazon Simple * Email Service. * @throws RuleDoesNotExistException * @throws RuleSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DescribeReceiptRuleResult describeReceiptRule( DescribeReceiptRuleRequest describeReceiptRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the details of the specified receipt rule set. *
** For information about managing receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param describeReceiptRuleSetRequest* Represents a request to return the details of a receipt rule * set. You use receipt rule sets to receive email with Amazon * SES. For more information, see the Amazon SES Developer Guide. *
* @return describeReceiptRuleSetResult The response from the * DescribeReceiptRuleSet service method, as returned by Amazon * Simple Email Service. * @throws RuleSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ DescribeReceiptRuleSetResult describeReceiptRuleSet( DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the email sending status of the Amazon SES account for the * current region. *
** You can execute this operation no more than once per second. *
* * @param getAccountSendingEnabledRequest * @return getAccountSendingEnabledResult The response from the * GetAccountSendingEnabled service method, as returned by Amazon * Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetAccountSendingEnabledResult getAccountSendingEnabled( GetAccountSendingEnabledRequest getAccountSendingEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the custom email verification template for the template name you * specify. *
** For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES * Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param getCustomVerificationEmailTemplateRequest* Represents a request to retrieve an existing custom * verification email template. *
* @return getCustomVerificationEmailTemplateResult The response from the * GetCustomVerificationEmailTemplate service method, as returned by * Amazon Simple Email Service. * @throws CustomVerificationEmailTemplateDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetCustomVerificationEmailTemplateResult getCustomVerificationEmailTemplate( GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the current status of Easy DKIM signing for an entity. For domain * name identities, this operation 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 operation 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 operation is throttled at one request per second and can only get * DKIM attributes for up to 100 identities at a time. *
** For more information about creating DNS records using DKIM tokens, go to * the Amazon SES Developer Guide. *
* * @param getIdentityDkimAttributesRequest* Represents a request for the status of Amazon SES Easy DKIM * signing for an identity. For domain identities, this request * also returns the DKIM tokens that are required for Easy DKIM * signing, and whether Amazon SES successfully verified that * these tokens were published. For more information about Easy * DKIM, see the Amazon SES Developer Guide. *
* @return getIdentityDkimAttributesResult The response from the * GetIdentityDkimAttributes service method, as returned by Amazon * Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetIdentityDkimAttributesResult getIdentityDkimAttributes( GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the custom MAIL FROM attributes for a list of identities (email * addresses : domains). *
** This operation is throttled at one request per second and can only get * custom MAIL FROM attributes for up to 100 identities at a time. *
* * @param getIdentityMailFromDomainAttributesRequest* Represents a request to return the Amazon SES custom MAIL FROM * attributes for a list of identities. For information about * using a custom MAIL FROM domain, see the Amazon SES Developer Guide. *
* @return getIdentityMailFromDomainAttributesResult The response from the * GetIdentityMailFromDomainAttributes service method, as returned * by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes( GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest) throws AmazonClientException, AmazonServiceException; /** ** Given a list of verified identities (email addresses and/or domains), * returns a structure describing identity notification attributes. *
** This operation is throttled at one request per second and can only get * notification attributes for up to 100 identities at a time. *
** For more information about using notifications with Amazon SES, see the * Amazon SES Developer Guide. *
* * @param getIdentityNotificationAttributesRequest* Represents a request to return the notification attributes for * a list of identities you verified with Amazon SES. For * information about Amazon SES notifications, see the Amazon SES Developer Guide. *
* @return getIdentityNotificationAttributesResult The response from the * GetIdentityNotificationAttributes service method, as returned by * Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetIdentityNotificationAttributesResult getIdentityNotificationAttributes( GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the requested sending authorization policies for the given * identity (an email address or a domain). The policies are returned as a * map of policy names to policy contents. You can retrieve a maximum of 20 * policies at a time. *
** This API is for the identity owner only. If you have not verified the * identity, this API will return an error. *
** Sending authorization is a feature that enables an identity owner to * authorize other senders to use its identities. For information about * using sending authorization, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param getIdentityPoliciesRequest* Represents a request to return the requested sending * authorization policies for an identity. Sending authorization * is an Amazon SES feature that enables you to authorize other * senders to use your identities. For information, see the Amazon SES Developer Guide. *
* @return getIdentityPoliciesResult The response from the * GetIdentityPolicies service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetIdentityPoliciesResult getIdentityPolicies( GetIdentityPoliciesRequest getIdentityPoliciesRequest) throws AmazonClientException, AmazonServiceException; /** ** Given a list of identities (email addresses and/or domains), returns the * verification status and (for domain identities) the verification token * for each identity. *
** The verification status of an email address is "Pending" until the email * address owner clicks the link within the verification email that Amazon * SES sent to that address. If the email address owner clicks the link * within 24 hours, the verification status of the email address changes to * "Success". If the link is not clicked within 24 hours, the verification * status changes to "Failed." In that case, if you still want to verify the * email address, you must restart the verification process from the * beginning. *
** For domain identities, the domain's verification status is "Pending" as * Amazon SES searches for the required TXT record in the DNS settings of * the domain. When Amazon SES detects the record, the domain's verification * status changes to "Success". If Amazon SES is unable to detect the record * within 72 hours, the domain's verification status changes to "Failed." In * that case, if you still want to verify the domain, you must restart the * verification process from the beginning. *
** This operation is throttled at one request per second and can only get * verification attributes for up to 100 identities at a time. *
* * @param getIdentityVerificationAttributesRequest* Represents a request to return the Amazon SES verification * status of a list of identities. For domain identities, this * request also returns the verification token. For information * about verifying identities with Amazon SES, see the Amazon SES Developer Guide. *
* @return getIdentityVerificationAttributesResult The response from the * GetIdentityVerificationAttributes service method, as returned by * Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetIdentityVerificationAttributesResult getIdentityVerificationAttributes( GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest) throws AmazonClientException, AmazonServiceException; /** ** Provides the sending limits for the Amazon SES account. *
** You can execute this operation no more than once per second. *
* * @param getSendQuotaRequest * @return getSendQuotaResult The response from the GetSendQuota service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest) throws AmazonClientException, AmazonServiceException; /** ** Provides sending statistics for the current AWS Region. 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 period of * time. *
** You can execute this operation no more than once per second. *
* * @param getSendStatisticsRequest * @return getSendStatisticsResult The response from the GetSendStatistics * service method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) throws AmazonClientException, AmazonServiceException; /** ** Displays the template object (which includes the Subject line, HTML part * and text part) for the template you specify. *
** You can execute this operation no more than once per second. *
* * @param getTemplateRequest * @return getTemplateResult The response from the GetTemplate service * method, as returned by Amazon Simple Email Service. * @throws TemplateDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Provides a list of the configuration sets associated with your Amazon SES * account in the current AWS Region. For information about using * configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES * Developer Guide. *
*
* You can execute this operation no more than once per second. This
* operation will return up to 1,000 configuration sets each time it is run.
* If your Amazon SES account has more than 1,000 configuration sets, this
* operation will also return a NextToken element. You can then execute the
* ListConfigurationSets
operation again, passing the
* NextToken
parameter and the value of the NextToken element
* to retrieve additional results.
*
* Represents a request to list the configuration sets associated * with your AWS account. Configuration sets enable you to * publish email sending events. For information about using * configuration sets, see the Amazon SES Developer Guide. *
* @return listConfigurationSetsResult The response from the * ListConfigurationSets service method, as returned by Amazon * Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListConfigurationSetsResult listConfigurationSets( ListConfigurationSetsRequest listConfigurationSetsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the existing custom verification email templates for your account * in the current AWS Region. *
** For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES * Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param listCustomVerificationEmailTemplatesRequest* Represents a request to list the existing custom verification * email templates for your account. *
** For more information about custom verification email * templates, see Using Custom Verification Email Templates in the * Amazon SES Developer Guide. *
* @return listCustomVerificationEmailTemplatesResult The response from the * ListCustomVerificationEmailTemplates service method, as returned * by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListCustomVerificationEmailTemplatesResult listCustomVerificationEmailTemplates( ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns a list containing all of the identities (email addresses and * domains) for your AWS account in the current AWS Region, regardless of * verification status. *
** You can execute this operation no more than once per second. *
* * @param listIdentitiesRequest* Represents a request to return a list of all identities (email * addresses and domains) that you have attempted to verify under * your AWS account, regardless of verification status. *
* @return listIdentitiesResult The response from the ListIdentities service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest) throws AmazonClientException, AmazonServiceException; /** *
* Returns a list of sending authorization policies that are attached to the
* given identity (an email address or a domain). This API returns only a
* list. If you want the actual policy content, you can use
* GetIdentityPolicies
.
*
* This API is for the identity owner only. If you have not verified the * identity, this API will return an error. *
** Sending authorization is a feature that enables an identity owner to * authorize other senders to use its identities. For information about * using sending authorization, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param listIdentityPoliciesRequest* Represents a request to return a list of sending authorization * policies that are attached to an identity. Sending * authorization is an Amazon SES feature that enables you to * authorize other senders to use your identities. For * information, see the Amazon SES Developer Guide. *
* @return listIdentityPoliciesResult The response from the * ListIdentityPolicies service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListIdentityPoliciesResult listIdentityPolicies( ListIdentityPoliciesRequest listIdentityPoliciesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the IP address filters associated with your AWS account in the * current AWS Region. *
** For information about managing IP address filters, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param listReceiptFiltersRequest* Represents a request to list the IP address filters that exist * under your AWS account. You use IP address filters when you * receive email with Amazon SES. For more information, see the * Amazon SES Developer Guide. *
* @return listReceiptFiltersResult The response from the ListReceiptFilters * service method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest) throws AmazonClientException, AmazonServiceException; /** *
* Lists the receipt rule sets that exist under your AWS account in the
* current AWS Region. If there are additional receipt rule sets to be
* retrieved, you will receive a NextToken
that you can provide
* to the next call to ListReceiptRuleSets
to retrieve the
* additional entries.
*
* For information about managing receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param listReceiptRuleSetsRequest* Represents a request to list the receipt rule sets that exist * under your AWS account. You use receipt rule sets to receive * email with Amazon SES. For more information, see the Amazon SES Developer Guide. *
* @return listReceiptRuleSetsResult The response from the * ListReceiptRuleSets service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListReceiptRuleSetsResult listReceiptRuleSets( ListReceiptRuleSetsRequest listReceiptRuleSetsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the email templates present in your Amazon SES account in the * current AWS Region. *
** You can execute this operation no more than once per second. *
* * @param listTemplatesRequest * @return listTemplatesResult The response from the ListTemplates service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest) throws AmazonClientException, AmazonServiceException; /** *
* Deprecated. Use the ListIdentities
operation to list the
* email addresses and domains associated with your account.
*
* Adds or updates the delivery options for a configuration set. *
* * @param putConfigurationSetDeliveryOptionsRequest* A request to modify the delivery options for a configuration * set. *
* @return putConfigurationSetDeliveryOptionsResult The response from the * PutConfigurationSetDeliveryOptions service method, as returned by * Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws InvalidDeliveryOptionsException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions( PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Adds or updates a sending authorization policy for the specified identity * (an email address or a domain). *
** This API is for the identity owner only. If you have not verified the * identity, this API will return an error. *
** Sending authorization is a feature that enables an identity owner to * authorize other senders to use its identities. For information about * using sending authorization, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param putIdentityPolicyRequest* Represents a request to add or update a sending authorization * policy for an identity. Sending authorization is an Amazon SES * feature that enables you to authorize other senders to use * your identities. For information, see the Amazon SES Developer Guide. *
* @return putIdentityPolicyResult The response from the PutIdentityPolicy * service method, as returned by Amazon Simple Email Service. * @throws InvalidPolicyException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Reorders the receipt rules within a receipt rule set. *
** All of the rules in the rule set must be represented in this request. * That is, this API will return an error if the reorder request doesn't * explicitly position all of the rules. *
** For information about managing receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param reorderReceiptRuleSetRequest* Represents a request to reorder the receipt rules within a * receipt rule set. You use receipt rule sets to receive email * with Amazon SES. For more information, see the Amazon SES Developer Guide. *
* @return reorderReceiptRuleSetResult The response from the * ReorderReceiptRuleSet service method, as returned by Amazon * Simple Email Service. * @throws RuleSetDoesNotExistException * @throws RuleDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ReorderReceiptRuleSetResult reorderReceiptRuleSet( ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Generates and sends a bounce message to the sender of an email you * received through Amazon SES. You can only use this API on an email up to * 24 hours after you receive it. *
** You cannot use this API to send generic bounces for mail that was not * received by Amazon SES. *
** For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param sendBounceRequest* Represents a request to send a bounce message to the sender of * an email you received through Amazon SES. *
* @return sendBounceResult The response from the SendBounce service method, * as returned by Amazon Simple Email Service. * @throws MessageRejectedException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SendBounceResult sendBounce(SendBounceRequest sendBounceRequest) throws AmazonClientException, AmazonServiceException; /** ** Composes an email message to multiple destinations. The message body is * created using an email template. *
*
* In order to send email using the SendBulkTemplatedEmail
* operation, your call to the API must meet the following requirements:
*
* The call must refer to an existing email template. You can create email * templates using the CreateTemplate operation. *
** The message must be sent from a verified email address or domain. *
** If your account is still in the Amazon SES sandbox, you may only send to * verified addresses or domains, or to email addresses associated with the * Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer * Guide. *
** The maximum message size is 10 MB. *
*
* Each Destination
parameter must include at least one
* recipient email address. The recipient address can be a To: address, a
* CC: address, or a BCC: address. If a recipient email address is invalid
* (that is, it is not in the format
* UserName@[SubDomain.]Domain.TopLevelDomain), the entire message
* will be rejected, even if the message contains other recipients that are
* valid.
*
* The message may not include more than 50 recipients, across the To:, CC:
* and BCC: fields. 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 the SendBulkTemplatedEmail
operation several
* times to send the message to each group.
*
* The number of destinations you can contact in a single call to the API * may be limited by your account's maximum sending rate. *
** Represents a request to send a templated email to multiple * destinations using Amazon SES. For more information, see the * Amazon SES Developer Guide. *
* @return sendBulkTemplatedEmailResult The response from the * SendBulkTemplatedEmail service method, as returned by Amazon * Simple Email Service. * @throws MessageRejectedException * @throws MailFromDomainNotVerifiedException * @throws ConfigurationSetDoesNotExistException * @throws TemplateDoesNotExistException * @throws ConfigurationSetSendingPausedException * @throws AccountSendingPausedException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SendBulkTemplatedEmailResult sendBulkTemplatedEmail( SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest) throws AmazonClientException, AmazonServiceException; /** ** Adds an email address to the list of identities for your Amazon SES * account in the current AWS Region and attempts to verify it. As a result * of executing this operation, a customized verification email is sent to * the specified address. *
** To use this operation, you must first create a custom verification email * template. For more information about creating and using custom * verification email templates, see Using Custom Verification Email Templates in the Amazon SES * Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param sendCustomVerificationEmailRequest* Represents a request to send a custom verification email to a * specified recipient. *
* @return sendCustomVerificationEmailResult The response from the * SendCustomVerificationEmail service method, as returned by Amazon * Simple Email Service. * @throws MessageRejectedException * @throws ConfigurationSetDoesNotExistException * @throws CustomVerificationEmailTemplateDoesNotExistException * @throws FromEmailAddressNotVerifiedException * @throws ProductionAccessNotGrantedException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SendCustomVerificationEmailResult sendCustomVerificationEmail( SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest) throws AmazonClientException, AmazonServiceException; /** *
* Composes an email message and immediately queues it for sending. In order
* to send email using the SendEmail
operation, your message
* must meet the following requirements:
*
* The message must be sent from a verified email address or domain. If you * attempt to send email using a non-verified address or domain, the * operation will result in an "Email address not verified" error. *
** If your account is still in the Amazon SES sandbox, you may only send to * verified addresses or domains, or to email addresses associated with the * Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer * Guide. *
** The maximum message size is 10 MB. *
** The message must include at least one recipient email address. The * recipient address can be a To: address, a CC: address, or a BCC: address. * If a recipient email address is invalid (that is, it is not in the format * UserName@[SubDomain.]Domain.TopLevelDomain), the entire message * will be rejected, even if the message contains other recipients that are * valid. *
*
* The message may not include more than 50 recipients, across the To:, CC:
* and BCC: fields. 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 the SendEmail
operation several times to send
* the message to each group.
*
* For every message that you send, the total number of recipients * (including each recipient in the To:, CC: and BCC: fields) is counted * against the maximum number of emails you can send in a 24-hour period * (your sending quota). For more information about sending quotas in * Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES * Developer Guide. *
** Represents a request to send a single formatted email using * Amazon SES. For more information, see the Amazon SES Developer Guide. *
* @return sendEmailResult The response from the SendEmail service method, * as returned by Amazon Simple Email Service. * @throws MessageRejectedException * @throws MailFromDomainNotVerifiedException * @throws ConfigurationSetDoesNotExistException * @throws ConfigurationSetSendingPausedException * @throws AccountSendingPausedException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SendEmailResult sendEmail(SendEmailRequest sendEmailRequest) throws AmazonClientException, AmazonServiceException; /** ** Composes an email message and immediately queues it for sending. *
*
* This operation is more flexible than the SendEmail
API
* operation. When you use the SendRawEmail
operation, you can
* specify the headers of the message as well as its content. This
* flexibility is useful, for example, when you want to send a multipart
* MIME email (such a message that contains both a text and an HTML
* version). You can also use this operation to send messages that include
* attachments.
*
* The SendRawEmail
operation has the following requirements:
*
* You can only send email from verified email addresses or domains. If you try to send email from * an address that isn't verified, the operation results in an * "Email address not verified" error. *
** If your account is still in the Amazon SES sandbox, you can only send email to other verified * addresses in your account, or to addresses that are associated with the * Amazon SES mailbox simulator. *
** The maximum message size, including attachments, is 10 MB. *
** Each message has to include at least one recipient address. A recipient * address includes any address on the To:, CC:, or BCC: lines. *
** If you send a single message to more than one recipient address, and one * of the recipient addresses isn't in a valid format (that is, it's not in * the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES * rejects the entire message, even if the other addresses are valid. *
** Each message can include up to 50 recipient addresses across the To:, * CC:, or BCC: lines. If you need to send a single message to more than 50 * recipients, you have to split the list of recipient addresses into groups * of less than 50 recipients, and send separate messages to each group. *
** Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME * message parts. However, if Amazon SES has to modify the contents of your * message (for example, if you use open and click tracking), 8-bit content * isn't preserved. For this reason, we highly recommend that you encode all * content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide. *
*
* Additionally, keep the following considerations in mind when using the
* SendRawEmail
operation:
*
* Although you can customize the message headers when using the
* SendRawEmail
operation, Amazon SES will automatically apply
* its own Message-ID
and Date
headers; if you
* passed these headers when creating the message, they will be overwritten
* by the values that Amazon SES provides.
*
* If you are using sending authorization to send on behalf of another user,
* SendRawEmail
enables you to specify the cross-account
* identity for the email's Source, From, and Return-Path parameters in one
* of two ways: you can pass optional parameters SourceArn
,
* FromArn
, and/or ReturnPathArn
to the API, or
* you can include the following X-headers in the header of your raw email:
*
* X-SES-SOURCE-ARN
*
* X-SES-FROM-ARN
*
* X-SES-RETURN-PATH-ARN
*
* Don't include these X-headers in the DKIM signature. Amazon SES removes * these before it sends the email. *
*
* If you only specify the SourceIdentityArn
parameter, Amazon
* SES sets the From and Return-Path addresses to the same identity that you
* specified.
*
* For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES * Developer Guide. *
** For every message that you send, the total number of recipients * (including each recipient in the To:, CC: and BCC: fields) is counted * against the maximum number of emails you can send in a 24-hour period * (your sending quota). For more information about sending quotas in * Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES * Developer Guide. *
** Represents a request to send a single raw email using Amazon * SES. For more information, see the Amazon SES Developer Guide. *
* @return sendRawEmailResult The response from the SendRawEmail service * method, as returned by Amazon Simple Email Service. * @throws MessageRejectedException * @throws MailFromDomainNotVerifiedException * @throws ConfigurationSetDoesNotExistException * @throws ConfigurationSetSendingPausedException * @throws AccountSendingPausedException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest) throws AmazonClientException, AmazonServiceException; /** ** Composes an email message using an email template and immediately queues * it for sending. *
*
* In order to send email using the SendTemplatedEmail
* operation, your call to the API must meet the following requirements:
*
* The call must refer to an existing email template. You can create email * templates using the CreateTemplate operation. *
** The message must be sent from a verified email address or domain. *
** If your account is still in the Amazon SES sandbox, you may only send to * verified addresses or domains, or to email addresses associated with the * Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer * Guide. *
** The maximum message size is 10 MB. *
*
* Calls to the SendTemplatedEmail
operation may only include
* one Destination
parameter. A destination is a set of
* recipients who will receive the same version of the email. The
* Destination
parameter can include up to 50 recipients,
* across the To:, CC: and BCC: fields.
*
* The Destination
parameter must include at least one
* recipient email address. The recipient address can be a To: address, a
* CC: address, or a BCC: address. If a recipient email address is invalid
* (that is, it is not in the format
* UserName@[SubDomain.]Domain.TopLevelDomain), the entire message
* will be rejected, even if the message contains other recipients that are
* valid.
*
* If your call to the SendTemplatedEmail
operation includes
* all of the required parameters, Amazon SES accepts it and returns a
* Message ID. However, if Amazon SES can't render the email because the
* template contains errors, it doesn't send the email. Additionally,
* because it already accepted the message, Amazon SES doesn't return a
* message stating that it was unable to send the email.
*
* For these reasons, we highly recommend that you set up Amazon SES to send * you notifications when Rendering Failure events occur. For more * information, see Sending Personalized Email Using the Amazon SES API in the Amazon * Simple Email Service Developer Guide. *
** Represents a request to send a templated email using Amazon * SES. For more information, see the Amazon SES Developer Guide. *
* @return sendTemplatedEmailResult The response from the SendTemplatedEmail * service method, as returned by Amazon Simple Email Service. * @throws MessageRejectedException * @throws MailFromDomainNotVerifiedException * @throws ConfigurationSetDoesNotExistException * @throws TemplateDoesNotExistException * @throws ConfigurationSetSendingPausedException * @throws AccountSendingPausedException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SendTemplatedEmailResult sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets the specified receipt rule set as the active receipt rule set. *
** To disable your email-receiving through Amazon SES completely, you can * call this API with RuleSetName set to null. *
** For information about managing receipt rule sets, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param setActiveReceiptRuleSetRequest* Represents a request to set a receipt rule set as the active * receipt rule set. You use receipt rule sets to receive email * with Amazon SES. For more information, see the Amazon SES Developer Guide. *
* @return setActiveReceiptRuleSetResult The response from the * SetActiveReceiptRuleSet service method, as returned by Amazon * Simple Email Service. * @throws RuleSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetActiveReceiptRuleSetResult setActiveReceiptRuleSet( SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest) throws AmazonClientException, AmazonServiceException; /** ** Enables or disables Easy DKIM signing of email sent from an identity. If * Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to * sign all email that it sends from addresses on that domain. If Easy DKIM * signing is enabled for an email address, then Amazon SES uses DKIM to * sign all email it sends from that address. *
*
* For email addresses (for example, user@example.com
), you can
* only enable DKIM signing if the corresponding domain (in this case,
* example.com
) has been set up to use Easy DKIM.
*
* You can enable DKIM signing for an identity at any time after you start * the verification process for the identity, even if the verification * process isn't complete. *
** You can execute this operation no more than once per second. *
** For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. *
* * @param setIdentityDkimEnabledRequest* Represents a request to enable or disable Amazon SES Easy DKIM * signing for an identity. For more information about setting up * Easy DKIM, see the Amazon SES Developer Guide. *
* @return setIdentityDkimEnabledResult The response from the * SetIdentityDkimEnabled service method, as returned by Amazon * Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetIdentityDkimEnabledResult setIdentityDkimEnabled( SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Given an identity (an email address or a 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. *
** Feedback forwarding does not apply to delivery notifications. Delivery * notifications are only available through Amazon SNS. *
** You can execute this operation no more than once per second. *
** For more information about using notifications with Amazon SES, see the * Amazon SES Developer Guide. *
* * @param setIdentityFeedbackForwardingEnabledRequest* Represents a request to enable or disable whether Amazon SES * forwards you bounce and complaint notifications through email. * For information about email feedback forwarding, see the Amazon SES Developer Guide. *
* @return setIdentityFeedbackForwardingEnabledResult The response from the * SetIdentityFeedbackForwardingEnabled service method, as returned * by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled( SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Given an identity (an email address or a domain), sets whether Amazon SES * includes the original email headers in the Amazon Simple Notification * Service (Amazon SNS) notifications of a specified type. *
** You can execute this operation no more than once per second. *
** For more information about using notifications with Amazon SES, see the * Amazon SES Developer Guide. *
* * @param setIdentityHeadersInNotificationsEnabledRequest* Represents a request to set whether Amazon SES includes the * original email headers in the Amazon SNS notifications of a * specified type. For information about notifications, see the * Amazon SES Developer Guide. *
* @return setIdentityHeadersInNotificationsEnabledResult The response from * the SetIdentityHeadersInNotificationsEnabled service method, as * returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetIdentityHeadersInNotificationsEnabledResult setIdentityHeadersInNotificationsEnabled( SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Enables or disables the custom MAIL FROM domain setup for a verified * identity (an email address or a domain). *
** To send emails using the specified MAIL FROM domain, you must add an MX * record to your MAIL FROM domain's DNS settings. If you want your emails * to pass Sender Policy Framework (SPF) checks, you must also add or update * an SPF record. For more information, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param setIdentityMailFromDomainRequest* Represents a request to enable or disable the Amazon SES * custom MAIL FROM domain setup for a verified identity. For * information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide. *
* @return setIdentityMailFromDomainResult The response from the * SetIdentityMailFromDomain service method, as returned by Amazon * Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetIdentityMailFromDomainResult setIdentityMailFromDomain( SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when * delivering notifications. When you use this operation, you specify a * verified identity, such as an email address or domain. When you send an * email that uses the chosen identity in the Source field, Amazon SES sends * notifications to the topic you specified. You can send bounce, complaint, * or delivery notifications (or any combination of the three) to the Amazon * SNS topic that you specify. *
** You can execute this operation no more than once per second. *
** For more information about feedback notification, see the Amazon SES Developer Guide. *
* * @param setIdentityNotificationTopicRequest* Represents a request to specify the Amazon SNS topic to which * Amazon SES will publish bounce, complaint, or delivery * notifications for emails sent with that identity as the * Source. For information about Amazon SES notifications, see * the Amazon SES Developer Guide. *
* @return setIdentityNotificationTopicResult The response from the * SetIdentityNotificationTopic service method, as returned by * Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetIdentityNotificationTopicResult setIdentityNotificationTopic( SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets the position of the specified receipt rule in the receipt rule set. *
** For information about managing receipt rules, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param setReceiptRulePositionRequest* Represents a request to set the position of a receipt rule in * a receipt rule set. You use receipt rule sets to receive email * with Amazon SES. For more information, see the Amazon SES Developer Guide. *
* @return setReceiptRulePositionResult The response from the * SetReceiptRulePosition service method, as returned by Amazon * Simple Email Service. * @throws RuleSetDoesNotExistException * @throws RuleDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ SetReceiptRulePositionResult setReceiptRulePosition( SetReceiptRulePositionRequest setReceiptRulePositionRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a preview of the MIME content of an email when provided with a * template and a set of replacement data. *
** You can execute this operation no more than once per second. *
* * @param testRenderTemplateRequest * @return testRenderTemplateResult The response from the TestRenderTemplate * service method, as returned by Amazon Simple Email Service. * @throws TemplateDoesNotExistException * @throws InvalidRenderingParameterException * @throws MissingRenderingAttributeException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ TestRenderTemplateResult testRenderTemplate(TestRenderTemplateRequest testRenderTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Enables or disables email sending across your entire Amazon SES account * in the current AWS Region. You can use this operation in conjunction with * Amazon CloudWatch alarms to temporarily pause email sending across your * Amazon SES account in a given AWS Region when reputation metrics (such as * your bounce or complaint rates) reach certain thresholds. *
** You can execute this operation no more than once per second. *
* * @param updateAccountSendingEnabledRequest* Represents a request to enable or disable the email sending * capabilities for your entire Amazon SES account. *
* @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void updateAccountSendingEnabled( UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the event destination of a configuration set. Event destinations * are associated with configuration sets, which enable you to publish email * sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon * Simple Notification Service (Amazon SNS). For information about using * configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES * Developer Guide. *
** When you create or update an event destination, you must provide one, and * only one, destination. The destination can be Amazon CloudWatch, Amazon * Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). *
** You can execute this operation no more than once per second. *
* * @param updateConfigurationSetEventDestinationRequest* Represents a request to update the event destination of a * configuration set. Configuration sets enable you to publish * email sending events. For information about using * configuration sets, see the Amazon SES Developer Guide. *
* @return updateConfigurationSetEventDestinationResult The response from * the UpdateConfigurationSetEventDestination service method, as * returned by Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws EventDestinationDoesNotExistException * @throws InvalidCloudWatchDestinationException * @throws InvalidFirehoseDestinationException * @throws InvalidSNSDestinationException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination( UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Enables or disables the publishing of reputation metrics for emails sent * using a specific configuration set in a given AWS Region. Reputation * metrics include bounce and complaint rates. These metrics are published * to Amazon CloudWatch. By using CloudWatch, you can create alarms when * bounce or complaint rates exceed certain thresholds. *
** You can execute this operation no more than once per second. *
* * @param updateConfigurationSetReputationMetricsEnabledRequest* Represents a request to modify the reputation metric * publishing settings for a configuration set. *
* @throws ConfigurationSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void updateConfigurationSetReputationMetricsEnabled( UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Enables or disables email sending for messages sent using a specific * configuration set in a given AWS Region. You can use this operation in * conjunction with Amazon CloudWatch alarms to temporarily pause email * sending for a configuration set when the reputation metrics for that * configuration set (such as your bounce on complaint rate) exceed certain * thresholds. *
** You can execute this operation no more than once per second. *
* * @param updateConfigurationSetSendingEnabledRequest* Represents a request to enable or disable the email sending * capabilities for a specific configuration set. *
* @throws ConfigurationSetDoesNotExistException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void updateConfigurationSetSendingEnabled( UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest) throws AmazonClientException, AmazonServiceException; /** ** Modifies an association between a configuration set and a custom domain * for open and click event tracking. *
** By default, images and links used for tracking open and click events are * hosted on domains operated by Amazon SES. You can configure a subdomain * of your own to handle these events. For information about using custom * domains, see the Amazon SES Developer Guide. *
* * @param updateConfigurationSetTrackingOptionsRequest* Represents a request to update the tracking options for a * configuration set. *
* @return updateConfigurationSetTrackingOptionsResult The response from the * UpdateConfigurationSetTrackingOptions service method, as returned * by Amazon Simple Email Service. * @throws ConfigurationSetDoesNotExistException * @throws TrackingOptionsDoesNotExistException * @throws InvalidTrackingOptionsException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ UpdateConfigurationSetTrackingOptionsResult updateConfigurationSetTrackingOptions( UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates an existing custom verification email template. *
** For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES * Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param updateCustomVerificationEmailTemplateRequest* Represents a request to update an existing custom verification * email template. *
* @throws CustomVerificationEmailTemplateDoesNotExistException * @throws FromEmailAddressNotVerifiedException * @throws CustomVerificationEmailInvalidContentException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void updateCustomVerificationEmailTemplate( UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a receipt rule. *
** For information about managing receipt rules, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param updateReceiptRuleRequest* Represents a request to update a receipt rule. You use receipt * rules to receive email with Amazon SES. For more information, * see the Amazon SES Developer Guide. *
* @return updateReceiptRuleResult The response from the UpdateReceiptRule * service method, as returned by Amazon Simple Email Service. * @throws InvalidSnsTopicException * @throws InvalidS3ConfigurationException * @throws InvalidLambdaFunctionException * @throws RuleSetDoesNotExistException * @throws RuleDoesNotExistException * @throws LimitExceededException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates an email template. Email templates enable you to send * personalized email to one or more destinations in a single API operation. * For more information, see the Amazon SES Developer Guide. *
** You can execute this operation no more than once per second. *
* * @param updateTemplateRequest * @return updateTemplateResult The response from the UpdateTemplate service * method, as returned by Amazon Simple Email Service. * @throws TemplateDoesNotExistException * @throws InvalidTemplateException * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns a set of DKIM tokens for a domain identity. *
*
* When you execute the VerifyDomainDkim
operation, the domain
* that you specify is added to the list of identities that are associated
* with your account. This is true even if you haven't already associated
* the domain with your account by using the
* VerifyDomainIdentity
operation. However, you can't send
* email from the domain until you either successfully verify it or you successfully set up DKIM for it.
*
* You use the tokens that are generated by this operation to create CNAME * records. When Amazon SES detects that you've added these records to the * DNS configuration for a domain, you can start sending email from that * domain. You can start sending email even if you haven't added the TXT * record provided by the VerifyDomainIdentity operation to the DNS * configuration for your domain. All email that you send from the domain is * authenticated using DKIM. *
** To create the CNAME records for DKIM authentication, use the following * values: *
** Name: token._domainkey.example.com *
** Type: CNAME *
** Value: token.dkim.amazonses.com *
** In the preceding example, replace token with one of the tokens * that are generated when you execute this operation. Replace * example.com with your domain. Repeat this process for each token * that's generated by this operation. *
** You can execute this operation no more than once per second. *
* * @param verifyDomainDkimRequest* Represents a request to generate the CNAME records needed to * set up Easy DKIM with Amazon SES. For more information about * setting up Easy DKIM, see the Amazon SES Developer Guide. *
* @return verifyDomainDkimResult The response from the VerifyDomainDkim * service method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) throws AmazonClientException, AmazonServiceException; /** ** Adds a domain to the list of identities for your Amazon SES account in * the current AWS Region and attempts to verify it. For more information * about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer * Guide. *
** You can execute this operation no more than once per second. *
* * @param verifyDomainIdentityRequest* Represents a request to begin Amazon SES domain verification * and to generate the TXT records that you must publish to the * DNS server of your domain to complete the verification. For * information about domain verification, see the Amazon SES Developer Guide. *
* @return verifyDomainIdentityResult The response from the * VerifyDomainIdentity service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ VerifyDomainIdentityResult verifyDomainIdentity( VerifyDomainIdentityRequest verifyDomainIdentityRequest) throws AmazonClientException, AmazonServiceException; /** *
* Deprecated. Use the VerifyEmailIdentity
operation to verify
* a new email address.
*
* Represents a request to begin email address verification with * Amazon SES. For information about email address verification, * see the Amazon SES Developer Guide. *
* @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ void verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) throws AmazonClientException, AmazonServiceException; /** ** Adds an email address to the list of identities for your Amazon SES * account in the current AWS region and attempts to verify it. As a result * of executing this operation, a verification email is sent to the * specified address. *
** You can execute this operation no more than once per second. *
* * @param verifyEmailIdentityRequest* Represents a request to begin email address verification with * Amazon SES. For information about email address verification, * see the Amazon SES Developer Guide. *
* @return verifyEmailIdentityResult The response from the * VerifyEmailIdentity service method, as returned by Amazon Simple * Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ VerifyEmailIdentityResult verifyEmailIdentity( VerifyEmailIdentityRequest verifyEmailIdentityRequest) throws AmazonClientException, AmazonServiceException; /** *
* Deprecated. Use the ListIdentities
operation to list the
* email addresses and domains associated with your account.
*
* Provides sending statistics for the current AWS Region. 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 period of * time. *
** You can execute this operation no more than once per second. *
* * @return getSendStatisticsResult The response from the GetSendStatistics * service method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetSendStatisticsResult getSendStatistics() throws AmazonClientException, AmazonServiceException; /** ** Returns a list containing all of the identities (email addresses and * domains) for your AWS account in the current AWS Region, regardless of * verification status. *
** You can execute this operation no more than once per second. *
* * @return listIdentitiesResult The response from the ListIdentities service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ ListIdentitiesResult listIdentities() throws AmazonClientException, AmazonServiceException; /** ** Provides the sending limits for the Amazon SES account. *
** You can execute this operation no more than once per second. *
* * @return getSendQuotaResult The response from the GetSendQuota service * method, as returned by Amazon Simple Email Service. * @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. * @throws AmazonServiceException If an error response is returned by Amazon * Simple Email Service indicating either a problem with the * data in the request, or a server side issue. */ GetSendQuotaResult getSendQuota() throws AmazonClientException, AmazonServiceException; /** * 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. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }