/* * Copyright 2012-2017 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 javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.simpleemail.model.*; import com.amazonaws.services.simpleemail.waiters.AmazonSimpleEmailServiceWaiters; /** * Interface for accessing Amazon SES. * <p> * <b>Note:</b> Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.simpleemail.AbstractAmazonSimpleEmailService} instead. * </p> * <p> * <fullname>Amazon Simple Email Service</fullname> * <p> * This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in * conjunction with the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer * Guide</a>. * </p> * <note> * <p> * For a list of Amazon SES endpoints to use in service requests, see <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html">Regions and Amazon SES</a> in the Amazon SES * Developer Guide. * </p> * </note> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSimpleEmailService { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "email"; /** * Overrides the default endpoint for this client ("https://email.us-east-1.amazonaws.com"). Callers can use this * method to control which AWS region they want to work with. * <p> * 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. * <p> * 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: <a * href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912"> * http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a> * <p> * <b>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.</b> * * @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. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * 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. * <p> * 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. * <p> * <b>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.</b> * * @param region * The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)} * for accessing a given region. Must not be null and must be a region where the service is available. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** * <p> * 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. * </p> * <p> * For information about setting up rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the CloneReceiptRuleSet operation returned by the service. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @throws AlreadyExistsException * Indicates that a resource could not be created because of a naming conflict. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @sample AmazonSimpleEmailService.CloneReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CloneReceiptRuleSet" target="_top">AWS API * Documentation</a> */ CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest); /** * <p> * Creates a configuration set. * </p> * <p> * Configuration sets enable you to publish email sending events. For information about using configuration sets, * see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the CreateConfigurationSet operation returned by the service. * @throws ConfigurationSetAlreadyExistsException * Indicates that the configuration set could not be created because of a naming conflict. * @throws InvalidConfigurationSetException * Indicates that the configuration set is invalid. See the error message for details. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @sample AmazonSimpleEmailService.CreateConfigurationSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSet" target="_top">AWS * API Documentation</a> */ CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest); /** * <p> * Creates a configuration set event destination. * </p> * <note> * <p> * When you create or update an event destination, you must provide one, and only one, destination. The destination * can be either Amazon CloudWatch or Amazon Kinesis Firehose. * </p> * </note> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the CreateConfigurationSetEventDestination operation returned by the service. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @throws EventDestinationAlreadyExistsException * Indicates that the event destination could not be created because of a naming conflict. * @throws InvalidCloudWatchDestinationException * Indicates that the Amazon CloudWatch destination is invalid. See the error message for details. * @throws InvalidFirehoseDestinationException * Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @sample AmazonSimpleEmailService.CreateConfigurationSetEventDestination * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetEventDestination" * target="_top">AWS API Documentation</a> */ CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination( CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest); /** * <p> * Creates a new IP address filter. * </p> * <p> * For information about setting up IP address filters, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the CreateReceiptFilter operation returned by the service. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @throws AlreadyExistsException * Indicates that a resource could not be created because of a naming conflict. * @sample AmazonSimpleEmailService.CreateReceiptFilter * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptFilter" target="_top">AWS API * Documentation</a> */ CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest); /** * <p> * Creates a receipt rule. * </p> * <p> * For information about setting up receipt rules, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the CreateReceiptRule operation returned by the service. * @throws InvalidSnsTopicException * Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the * topic, possibly due to permissions issues. For information about giving permissions, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES * Developer Guide</a>. * @throws InvalidS3ConfigurationException * Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES * could not publish to the bucket, possibly due to permissions issues. For information about giving * permissions, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES * Developer Guide</a>. * @throws InvalidLambdaFunctionException * Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the * provided function, possibly due to permissions issues. For information about giving permissions, see the * <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon * SES Developer Guide</a>. * @throws AlreadyExistsException * Indicates that a resource could not be created because of a naming conflict. * @throws RuleDoesNotExistException * Indicates that the provided receipt rule does not exist. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @sample AmazonSimpleEmailService.CreateReceiptRule * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRule" target="_top">AWS API * Documentation</a> */ CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest); /** * <p> * Creates an empty receipt rule set. * </p> * <p> * For information about setting up receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the CreateReceiptRuleSet operation returned by the service. * @throws AlreadyExistsException * Indicates that a resource could not be created because of a naming conflict. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @sample AmazonSimpleEmailService.CreateReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleSet" target="_top">AWS API * Documentation</a> */ CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest); /** * <p> * Deletes a configuration set. * </p> * <p> * Configuration sets enable you to publish email sending events. For information about using configuration sets, * see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the DeleteConfigurationSet operation returned by the service. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @sample AmazonSimpleEmailService.DeleteConfigurationSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSet" target="_top">AWS * API Documentation</a> */ DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest); /** * <p> * Deletes a configuration set event destination. * </p> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the DeleteConfigurationSetEventDestination operation returned by the service. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @throws EventDestinationDoesNotExistException * Indicates that the event destination does not exist. * @sample AmazonSimpleEmailService.DeleteConfigurationSetEventDestination * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetEventDestination" * target="_top">AWS API Documentation</a> */ DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination( DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest); /** * <p> * Deletes the specified identity (an email address or a domain) from the list of verified identities. * </p> * <p> * This action is throttled at one request per second. * </p> * * @param deleteIdentityRequest * Represents a request to delete one of your Amazon SES identities (an email address or domain). * @return Result of the DeleteIdentity operation returned by the service. * @sample AmazonSimpleEmailService.DeleteIdentity * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentity" target="_top">AWS API * Documentation</a> */ DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest); /** * <p> * 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. * </p> * <note> * <p> * This API is for the identity owner only. If you have not verified the identity, this API will return an error. * </p> * </note> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon * SES Developer Guide</a>. * @return Result of the DeleteIdentityPolicy operation returned by the service. * @sample AmazonSimpleEmailService.DeleteIdentityPolicy * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentityPolicy" target="_top">AWS API * Documentation</a> */ DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest); /** * <p> * Deletes the specified IP address filter. * </p> * <p> * For information about managing IP address filters, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the DeleteReceiptFilter operation returned by the service. * @sample AmazonSimpleEmailService.DeleteReceiptFilter * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptFilter" target="_top">AWS API * Documentation</a> */ DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest); /** * <p> * Deletes the specified receipt rule. * </p> * <p> * For information about managing receipt rules, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon * SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the DeleteReceiptRule operation returned by the service. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @sample AmazonSimpleEmailService.DeleteReceiptRule * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptRule" target="_top">AWS API * Documentation</a> */ DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest); /** * <p> * Deletes the specified receipt rule set and all of the receipt rules it contains. * </p> * <note> * <p> * The currently active rule set cannot be deleted. * </p> * </note> * <p> * For information about managing receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html" * >Amazon SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the DeleteReceiptRuleSet operation returned by the service. * @throws CannotDeleteException * Indicates that the delete operation could not be completed. * @sample AmazonSimpleEmailService.DeleteReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptRuleSet" target="_top">AWS API * Documentation</a> */ DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest); /** * <p> * Deletes the specified email address from the list of verified addresses. * </p> * <important> * <p> * The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The * DeleteIdentity action is now preferred. * </p> * </important> * <p> * This action is throttled at one request per second. * </p> * * @param deleteVerifiedEmailAddressRequest * Represents a request to delete an email address from the list of email addresses you have attempted to * verify under your AWS account. * @return Result of the DeleteVerifiedEmailAddress operation returned by the service. * @sample AmazonSimpleEmailService.DeleteVerifiedEmailAddress * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteVerifiedEmailAddress" * target="_top">AWS API Documentation</a> */ DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest); /** * <p> * Returns the metadata and receipt rules for the receipt rule set that is currently active. * </p> * <p> * For information about setting up receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the DescribeActiveReceiptRuleSet operation returned by the service. * @sample AmazonSimpleEmailService.DescribeActiveReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeActiveReceiptRuleSet" * target="_top">AWS API Documentation</a> */ DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest); /** * <p> * Returns the details of the specified configuration set. * </p> * <p> * Configuration sets enable you to publish email sending events. For information about using configuration sets, * see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the DescribeConfigurationSet operation returned by the service. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @sample AmazonSimpleEmailService.DescribeConfigurationSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeConfigurationSet" target="_top">AWS * API Documentation</a> */ DescribeConfigurationSetResult describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest); /** * <p> * Returns the details of the specified receipt rule. * </p> * <p> * For information about setting up receipt rules, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the DescribeReceiptRule operation returned by the service. * @throws RuleDoesNotExistException * Indicates that the provided receipt rule does not exist. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @sample AmazonSimpleEmailService.DescribeReceiptRule * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeReceiptRule" target="_top">AWS API * Documentation</a> */ DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest); /** * <p> * Returns the details of the specified receipt rule set. * </p> * <p> * For information about managing receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html" * >Amazon SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the DescribeReceiptRuleSet operation returned by the service. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @sample AmazonSimpleEmailService.DescribeReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeReceiptRuleSet" target="_top">AWS * API Documentation</a> */ DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest); /** * <p> * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also * returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified * that these tokens have been published. * </p> * <p> * This action takes a list of identities as input and returns the following information for each: * </p> * <ul> * <li> * <p> * Whether Easy DKIM signing is enabled or disabled. * </p> * </li> * <li> * <p> * A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the * domain of that address. * </p> * </li> * <li> * <p> * 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. * </p> * </li> * </ul> * <p> * This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a * time. * </p> * <p> * For more information about creating DNS records using DKIM tokens, go to the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer * Guide</a>. * </p> * * @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 <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer * Guide</a>. * @return Result of the GetIdentityDkimAttributes operation returned by the service. * @sample AmazonSimpleEmailService.GetIdentityDkimAttributes * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityDkimAttributes" * target="_top">AWS API Documentation</a> */ GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest); /** * <p> * Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains). * </p> * <p> * This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 * identities at a time. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html">Amazon SES Developer Guide</a>. * @return Result of the GetIdentityMailFromDomainAttributes operation returned by the service. * @sample AmazonSimpleEmailService.GetIdentityMailFromDomainAttributes * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityMailFromDomainAttributes" * target="_top">AWS API Documentation</a> */ GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes( GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest); /** * <p> * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity * notification attributes. * </p> * <p> * This action is throttled at one request per second and can only get notification attributes for up to 100 * identities at a time. * </p> * <p> * For more information about using notifications with Amazon SES, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer * Guide</a>. * @return Result of the GetIdentityNotificationAttributes operation returned by the service. * @sample AmazonSimpleEmailService.GetIdentityNotificationAttributes * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityNotificationAttributes" * target="_top">AWS API Documentation</a> */ GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest); /** * <p> * 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. * </p> * <note> * <p> * This API is for the identity owner only. If you have not verified the identity, this API will return an error. * </p> * </note> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES * Developer Guide</a>. * @return Result of the GetIdentityPolicies operation returned by the service. * @sample AmazonSimpleEmailService.GetIdentityPolicies * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityPolicies" target="_top">AWS API * Documentation</a> */ GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest); /** * <p> * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain * identities) the verification token for each identity. * </p> * <p> * This action is throttled at one request per second and can only get verification attributes for up to 100 * identities at a time. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES * Developer Guide</a>. * @return Result of the GetIdentityVerificationAttributes operation returned by the service. * @sample AmazonSimpleEmailService.GetIdentityVerificationAttributes * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityVerificationAttributes" * target="_top">AWS API Documentation</a> */ GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest); /** * <p> * Returns the user's current sending limits. * </p> * <p> * This action is throttled at one request per second. * </p> * * @param getSendQuotaRequest * @return Result of the GetSendQuota operation returned by the service. * @sample AmazonSimpleEmailService.GetSendQuota * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetSendQuota" target="_top">AWS API * Documentation</a> */ GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest); /** * Simplified method form for invoking the GetSendQuota operation. * * @see #getSendQuota(GetSendQuotaRequest) */ GetSendQuotaResult getSendQuota(); /** * <p> * Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of * sending activity. * </p> * <p> * Each data point in the list contains statistics for a 15-minute interval. * </p> * <p> * This action is throttled at one request per second. * </p> * * @param getSendStatisticsRequest * @return Result of the GetSendStatistics operation returned by the service. * @sample AmazonSimpleEmailService.GetSendStatistics * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetSendStatistics" target="_top">AWS API * Documentation</a> */ GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest); /** * Simplified method form for invoking the GetSendStatistics operation. * * @see #getSendStatistics(GetSendStatisticsRequest) */ GetSendStatisticsResult getSendStatistics(); /** * <p> * Lists the configuration sets associated with your AWS account. * </p> * <p> * Configuration sets enable you to publish email sending events. For information about using configuration sets, * see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second and can return up to 50 configuration sets at a time. * </p> * * @param listConfigurationSetsRequest * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the ListConfigurationSets operation returned by the service. * @sample AmazonSimpleEmailService.ListConfigurationSets * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListConfigurationSets" target="_top">AWS * API Documentation</a> */ ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest); /** * <p> * Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of * verification status. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 Result of the ListIdentities operation returned by the service. * @sample AmazonSimpleEmailService.ListIdentities * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentities" target="_top">AWS API * Documentation</a> */ ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest); /** * Simplified method form for invoking the ListIdentities operation. * * @see #listIdentities(ListIdentitiesRequest) */ ListIdentitiesResult listIdentities(); /** * <p> * 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 * <code>GetIdentityPolicies</code>. * </p> * <note> * <p> * This API is for the identity owner only. If you have not verified the identity, this API will return an error. * </p> * </note> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES * Developer Guide</a>. * @return Result of the ListIdentityPolicies operation returned by the service. * @sample AmazonSimpleEmailService.ListIdentityPolicies * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentityPolicies" target="_top">AWS API * Documentation</a> */ ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest); /** * <p> * Lists the IP address filters associated with your AWS account. * </p> * <p> * For information about managing IP address filters, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES * Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the ListReceiptFilters operation returned by the service. * @sample AmazonSimpleEmailService.ListReceiptFilters * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListReceiptFilters" target="_top">AWS API * Documentation</a> */ ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest); /** * <p> * Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be * retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to * <code>ListReceiptRuleSets</code> to retrieve the additional entries. * </p> * <p> * For information about managing receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html" * >Amazon SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the ListReceiptRuleSets operation returned by the service. * @sample AmazonSimpleEmailService.ListReceiptRuleSets * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListReceiptRuleSets" target="_top">AWS API * Documentation</a> */ ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest); /** * <p> * Returns a list containing all of the email addresses that have been verified. * </p> * <important> * <p> * The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The * ListIdentities action is now preferred. * </p> * </important> * <p> * This action is throttled at one request per second. * </p> * * @param listVerifiedEmailAddressesRequest * @return Result of the ListVerifiedEmailAddresses operation returned by the service. * @sample AmazonSimpleEmailService.ListVerifiedEmailAddresses * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListVerifiedEmailAddresses" * target="_top">AWS API Documentation</a> */ ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest); /** * Simplified method form for invoking the ListVerifiedEmailAddresses operation. * * @see #listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest) */ ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(); /** * <p> * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). * </p> * <note> * <p> * This API is for the identity owner only. If you have not verified the identity, this API will return an error. * </p> * </note> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES * Developer Guide</a>. * @return Result of the PutIdentityPolicy operation returned by the service. * @throws InvalidPolicyException * Indicates that the provided policy is invalid. Check the error stack for more information about what * caused the error. * @sample AmazonSimpleEmailService.PutIdentityPolicy * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutIdentityPolicy" target="_top">AWS API * Documentation</a> */ PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest); /** * <p> * Reorders the receipt rules within a receipt rule set. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * For information about managing receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html" * >Amazon SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the ReorderReceiptRuleSet operation returned by the service. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @throws RuleDoesNotExistException * Indicates that the provided receipt rule does not exist. * @sample AmazonSimpleEmailService.ReorderReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReorderReceiptRuleSet" target="_top">AWS * API Documentation</a> */ ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest); /** * <p> * 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. * </p> * <note> * <p> * You cannot use this API to send generic bounces for mail that was not received by Amazon SES. * </p> * </note> * <p> * For information about receiving email through Amazon SES, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html">Amazon SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @param sendBounceRequest * Represents a request to send a bounce message to the sender of an email you received through Amazon SES. * @return Result of the SendBounce operation returned by the service. * @throws MessageRejectedException * Indicates that the action failed, and the message could not be sent. Check the error stack for more * information about what caused the error. * @sample AmazonSimpleEmailService.SendBounce * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBounce" target="_top">AWS API * Documentation</a> */ SendBounceResult sendBounce(SendBounceRequest sendBounceRequest); /** * <p> * Composes an email message based on input data, and then immediately queues the message for sending. * </p> * <p> * There are several important points to know about <code>SendEmail</code>: * </p> * <ul> * <li> * <p> * You can only send email from verified email addresses and domains; otherwise, you will get an * "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify * every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more * information, go to the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES * Developer Guide</a>. * </p> * </li> * <li> * <p> * The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. * </p> * </li> * <li> * <p> * Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: * email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your * recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group. * </p> * </li> * <li> * <p> * For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your * sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending * quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon * SES Developer Guide</a>. * </p> * </li> * </ul> * * @param sendEmailRequest * Represents a request to send a single formatted email using Amazon SES. For more information, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html">Amazon SES Developer * Guide</a>. * @return Result of the SendEmail operation returned by the service. * @throws MessageRejectedException * Indicates that the action failed, and the message could not be sent. Check the error stack for more * information about what caused the error. * @throws MailFromDomainNotVerifiedException * Indicates that the message could not be sent because Amazon SES could not read the MX record required to * use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings * for an identity, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-edit.html">Amazon SES Developer * Guide</a>. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @sample AmazonSimpleEmailService.SendEmail * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendEmail" target="_top">AWS API * Documentation</a> */ SendEmailResult sendEmail(SendEmailRequest sendEmailRequest); /** * <p> * Sends an email message, with header and content specified by the client. The <code>SendRawEmail</code> action is * useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; * otherwise, the message cannot be sent. * </p> * <p> * There are several important points to know about <code>SendRawEmail</code>: * </p> * <ul> * <li> * <p> * You can only send email from verified email addresses and domains; otherwise, you will get an * "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify * every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more * information, go to the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES * Developer Guide</a>. * </p> * </li> * <li> * <p> * The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. * </p> * </li> * <li> * <p> * Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: * email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your * recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group. * </p> * </li> * <li> * <p> * The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group * list counts towards the 50-recipient limit. * </p> * </li> * <li> * <p> * Amazon SES overrides any Message-ID and Date headers you provide. * </p> * </li> * <li> * <p> * For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your * sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending * quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon * SES Developer Guide</a>. * </p> * </li> * <li> * <p> * If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> 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 <code>SourceArn</code>, <code>FromArn</code>, and/or * <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw * email: * </p> * <ul> * <li> * <p> * <code>X-SES-SOURCE-ARN</code> * </p> * </li> * <li> * <p> * <code>X-SES-FROM-ARN</code> * </p> * </li> * <li> * <p> * <code>X-SES-RETURN-PATH-ARN</code> * </p> * </li> * </ul> * <important> * <p> * Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the * email. * </p> * </important> * <p> * For the most common sending authorization use case, we recommend that you specify the * <code>SourceIdentityArn</code> and do not specify either the <code>FromIdentityArn</code> or * <code>ReturnPathIdentityArn</code>. (The same note applies to the corresponding X-headers.) If you only specify * the <code>SourceIdentityArn</code>, Amazon SES will simply set the "From" address and the "Return Path" address * to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, * see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES * Developer Guide</a>. * </p> * </li> * </ul> * * @param sendRawEmailRequest * Represents a request to send a single raw email using Amazon SES. For more information, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html">Amazon SES Developer * Guide</a>. * @return Result of the SendRawEmail operation returned by the service. * @throws MessageRejectedException * Indicates that the action failed, and the message could not be sent. Check the error stack for more * information about what caused the error. * @throws MailFromDomainNotVerifiedException * Indicates that the message could not be sent because Amazon SES could not read the MX record required to * use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings * for an identity, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-edit.html">Amazon SES Developer * Guide</a>. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @sample AmazonSimpleEmailService.SendRawEmail * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendRawEmail" target="_top">AWS API * Documentation</a> */ SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest); /** * <p> * Sets the specified receipt rule set as the active receipt rule set. * </p> * <note> * <p> * To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to * null. * </p> * </note> * <p> * For information about managing receipt rule sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html" * >Amazon SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the SetActiveReceiptRuleSet operation returned by the service. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @sample AmazonSimpleEmailService.SetActiveReceiptRuleSet * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetActiveReceiptRuleSet" target="_top">AWS * API Documentation</a> */ SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest); /** * <p> * Enables or disables Easy DKIM signing of email sent from an identity: * </p> * <ul> * <li> * <p> * If Easy DKIM signing is enabled for a domain name identity (e.g., <code>example.com</code>), then Amazon SES will * DKIM-sign all email sent by addresses under that domain name (e.g., <code>user@example.com</code>). * </p> * </li> * <li> * <p> * If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email * address. * </p> * </li> * </ul> * <p> * For email addresses (e.g., <code>user@example.com</code>), you can only enable Easy DKIM signing if the * corresponding domain (e.g., <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the * <code>VerifyDomainDkim</code> action. * </p> * <p> * This action is throttled at one request per second. * </p> * <p> * For more information about Easy DKIM signing, go to the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. * @return Result of the SetIdentityDkimEnabled operation returned by the service. * @sample AmazonSimpleEmailService.SetIdentityDkimEnabled * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityDkimEnabled" target="_top">AWS * API Documentation</a> */ SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest); /** * <p> * 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. * </p> * <note> * <p> * Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through * Amazon SNS. * </p> * </note> * <p> * This action is throttled at one request per second. * </p> * <p> * For more information about using notifications with Amazon SES, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-email.html">Amazon SES * Developer Guide</a>. * @return Result of the SetIdentityFeedbackForwardingEnabled operation returned by the service. * @sample AmazonSimpleEmailService.SetIdentityFeedbackForwardingEnabled * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityFeedbackForwardingEnabled" * target="_top">AWS API Documentation</a> */ SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled( SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest); /** * <p> * 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. * </p> * <p> * This action is throttled at one request per second. * </p> * <p> * For more information about using notifications with Amazon SES, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html">Amazon SES * Developer Guide</a>. * @return Result of the SetIdentityHeadersInNotificationsEnabled operation returned by the service. * @sample AmazonSimpleEmailService.SetIdentityHeadersInNotificationsEnabled * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityHeadersInNotificationsEnabled" * target="_top">AWS API Documentation</a> */ SetIdentityHeadersInNotificationsEnabledResult setIdentityHeadersInNotificationsEnabled( SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest); /** * <p> * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). * </p> * <important> * <p> * 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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html">Amazon SES Developer Guide</a>. * </p> * </important> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html">Amazon SES Developer Guide</a>. * @return Result of the SetIdentityMailFromDomain operation returned by the service. * @sample AmazonSimpleEmailService.SetIdentityMailFromDomain * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityMailFromDomain" * target="_top">AWS API Documentation</a> */ SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest); /** * <p> * Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic * to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that * identity as the <code>Source</code>. * </p> * <note> * <p> * Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. * For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>. * </p> * </note> * <p> * This action is throttled at one request per second. * </p> * <p> * For more information about feedback notification, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html">Amazon SES * Developer Guide</a>. * @return Result of the SetIdentityNotificationTopic operation returned by the service. * @sample AmazonSimpleEmailService.SetIdentityNotificationTopic * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityNotificationTopic" * target="_top">AWS API Documentation</a> */ SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest); /** * <p> * Sets the position of the specified receipt rule in the receipt rule set. * </p> * <p> * For information about managing receipt rules, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon * SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the SetReceiptRulePosition operation returned by the service. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @throws RuleDoesNotExistException * Indicates that the provided receipt rule does not exist. * @sample AmazonSimpleEmailService.SetReceiptRulePosition * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetReceiptRulePosition" target="_top">AWS * API Documentation</a> */ SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest); /** * <p> * Updates the event destination of a configuration set. * </p> * <note> * <p> * When you create or update an event destination, you must provide one, and only one, destination. The destination * can be either Amazon CloudWatch or Amazon Kinesis Firehose. * </p> * </note> * <p> * Event destinations are associated with configuration sets, which enable you to publish email sending events to * Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer * Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES * Developer Guide</a>. * @return Result of the UpdateConfigurationSetEventDestination operation returned by the service. * @throws ConfigurationSetDoesNotExistException * Indicates that the configuration set does not exist. * @throws EventDestinationDoesNotExistException * Indicates that the event destination does not exist. * @throws InvalidCloudWatchDestinationException * Indicates that the Amazon CloudWatch destination is invalid. See the error message for details. * @throws InvalidFirehoseDestinationException * Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details. * @sample AmazonSimpleEmailService.UpdateConfigurationSetEventDestination * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetEventDestination" * target="_top">AWS API Documentation</a> */ UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination( UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest); /** * <p> * Updates a receipt rule. * </p> * <p> * For information about managing receipt rules, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon * SES Developer Guide</a>. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html">Amazon SES * Developer Guide</a>. * @return Result of the UpdateReceiptRule operation returned by the service. * @throws InvalidSnsTopicException * Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the * topic, possibly due to permissions issues. For information about giving permissions, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES * Developer Guide</a>. * @throws InvalidS3ConfigurationException * Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES * could not publish to the bucket, possibly due to permissions issues. For information about giving * permissions, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES * Developer Guide</a>. * @throws InvalidLambdaFunctionException * Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the * provided function, possibly due to permissions issues. For information about giving permissions, see the * <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon * SES Developer Guide</a>. * @throws RuleSetDoesNotExistException * Indicates that the provided receipt rule set does not exist. * @throws RuleDoesNotExistException * Indicates that the provided receipt rule does not exist. * @throws LimitExceededException * Indicates that a resource could not be created because of service limits. For a list of Amazon SES * limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES * Developer Guide</a>. * @sample AmazonSimpleEmailService.UpdateReceiptRule * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateReceiptRule" target="_top">AWS API * Documentation</a> */ UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest); /** * <p> * Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's * identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by * Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection * process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email * originating from that domain. * </p> * <p> * This action is throttled at one request per second. * </p> * <p> * To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> action. * </p> * <p> * For more information about creating DNS records using DKIM tokens, go to the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer * Guide</a>. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. * @return Result of the VerifyDomainDkim operation returned by the service. * @sample AmazonSimpleEmailService.VerifyDomainDkim * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainDkim" target="_top">AWS API * Documentation</a> */ VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest); /** * <p> * Verifies a domain. * </p> * <p> * This action is throttled at one request per second. * </p> * * @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 <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html">Amazon SES Developer * Guide</a>. * @return Result of the VerifyDomainIdentity operation returned by the service. * @sample AmazonSimpleEmailService.VerifyDomainIdentity * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainIdentity" target="_top">AWS API * Documentation</a> */ VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest); /** * <p> * Verifies an email address. This action causes a confirmation email message to be sent to the specified address. * </p> * <important> * <p> * The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The * VerifyEmailIdentity action is now preferred. * </p> * </important> * <p> * This action is throttled at one request per second. * </p> * * @param verifyEmailAddressRequest * Represents a request to begin email address verification with Amazon SES. For information about email * address verification, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">Amazon SES * Developer Guide</a>. * @return Result of the VerifyEmailAddress operation returned by the service. * @sample AmazonSimpleEmailService.VerifyEmailAddress * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyEmailAddress" target="_top">AWS API * Documentation</a> */ VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest); /** * <p> * Verifies an email address. This action causes a confirmation email message to be sent to the specified address. * </p> * <p> * This action is throttled at one request per second. * </p> * * @param verifyEmailIdentityRequest * Represents a request to begin email address verification with Amazon SES. For information about email * address verification, see the <a * href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">Amazon SES * Developer Guide</a>. * @return Result of the VerifyEmailIdentity operation returned by the service. * @sample AmazonSimpleEmailService.VerifyEmailIdentity * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyEmailIdentity" target="_top">AWS API * Documentation</a> */ VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest); /** * 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. */ 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. * <p> * 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. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); AmazonSimpleEmailServiceWaiters waiters(); }