Package software.amazon.awssdk.services.ses

Interface SESClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface SESClient
extends AutoCloseable

Service client for accessing Amazon SES. This can be created using the static builder() method. Amazon Simple Email Service

This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SESClientBuilder	builder()	Create a builder that can be used to configure and create a SESClient.
default CloneReceiptRuleSetResponse	cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)	Creates a receipt rule set by cloning an existing one.
static SESClient	create()	Create a SESClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateConfigurationSetResponse	createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)	Creates a configuration set.
default CreateConfigurationSetEventDestinationResponse	createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)	Creates a configuration set event destination.
default CreateReceiptFilterResponse	createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)	Creates a new IP address filter.
default CreateReceiptRuleResponse	createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)	Creates a receipt rule.
default CreateReceiptRuleSetResponse	createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)	Creates an empty receipt rule set.
default DeleteConfigurationSetResponse	deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)	Deletes a configuration set.
default DeleteConfigurationSetEventDestinationResponse	deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)	Deletes a configuration set event destination.
default DeleteIdentityResponse	deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)	Deletes the specified identity (an email address or a domain) from the list of verified identities.
default DeleteIdentityPolicyResponse	deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)	Deletes the specified sending authorization policy for the given identity (an email address or a domain).
default DeleteReceiptFilterResponse	deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)	Deletes the specified IP address filter.
default DeleteReceiptRuleResponse	deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)	Deletes the specified receipt rule.
default DeleteReceiptRuleSetResponse	deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)	Deletes the specified receipt rule set and all of the receipt rules it contains.
default DeleteVerifiedEmailAddressResponse	deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)	Deletes the specified email address from the list of verified addresses.
default DescribeActiveReceiptRuleSetResponse	describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)	Returns the metadata and receipt rules for the receipt rule set that is currently active.
default DescribeConfigurationSetResponse	describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)	Returns the details of the specified configuration set.
default DescribeReceiptRuleResponse	describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)	Returns the details of the specified receipt rule.
default DescribeReceiptRuleSetResponse	describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)	Returns the details of the specified receipt rule set.
default GetIdentityDkimAttributesResponse	getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)	Returns the current status of Easy DKIM signing for an entity.
default GetIdentityMailFromDomainAttributesResponse	getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)	Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).
default GetIdentityNotificationAttributesResponse	getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)	Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
default GetIdentityPoliciesResponse	getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)	Returns the requested sending authorization policies for the given identity (an email address or a domain).
default GetIdentityVerificationAttributesResponse	getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest)	Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
default GetSendQuotaResponse	getSendQuota(GetSendQuotaRequest getSendQuotaRequest)	Returns the user's current sending limits.
default GetSendStatisticsResponse	getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)	Returns the user's sending statistics.
default ListConfigurationSetsResponse	listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)	Lists the configuration sets associated with your AWS account.
default ListIdentitiesResponse	listIdentities(ListIdentitiesRequest listIdentitiesRequest)	Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
default ListIdentityPoliciesResponse	listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)	Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).
default ListReceiptFiltersResponse	listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)	Lists the IP address filters associated with your AWS account.
default ListReceiptRuleSetsResponse	listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)	Lists the receipt rule sets that exist under your AWS account.
default ListVerifiedEmailAddressesResponse	listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)	Returns a list containing all of the email addresses that have been verified.
default PutIdentityPolicyResponse	putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)	Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
default ReorderReceiptRuleSetResponse	reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)	Reorders the receipt rules within a receipt rule set.
default SendBounceResponse	sendBounce(SendBounceRequest sendBounceRequest)	Generates and sends a bounce message to the sender of an email you received through Amazon SES.
default SendEmailResponse	sendEmail(SendEmailRequest sendEmailRequest)	Composes an email message based on input data, and then immediately queues the message for sending.
default SendRawEmailResponse	sendRawEmail(SendRawEmailRequest sendRawEmailRequest)	Sends an email message, with header and content specified by the client.
static ServiceMetadata	serviceMetadata()
default SetActiveReceiptRuleSetResponse	setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)	Sets the specified receipt rule set as the active receipt rule set.
default SetIdentityDkimEnabledResponse	setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)	Enables or disables Easy DKIM signing of email sent from an identity:
default SetIdentityFeedbackForwardingEnabledResponse	setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest)	Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.
default SetIdentityHeadersInNotificationsEnabledResponse	setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest)	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.
default SetIdentityMailFromDomainResponse	setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)	Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
default SetIdentityNotificationTopicResponse	setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)	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 Source.
default SetReceiptRulePositionResponse	setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)	Sets the position of the specified receipt rule in the receipt rule set.
default UpdateConfigurationSetEventDestinationResponse	updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)	Updates the event destination of a configuration set.
default UpdateReceiptRuleResponse	updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)	Updates a receipt rule.
default VerifyDomainDkimResponse	verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)	Returns a set of DKIM tokens for a domain.
default VerifyDomainIdentityResponse	verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)	Verifies a domain.
default VerifyEmailAddressResponse	verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)	Verifies an email address.
default VerifyEmailIdentityResponse	verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)	Verifies an email address.
SESClientWaiters	waiters()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static SESClient create()

Create a SESClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SESClientBuilder builder()

Create a builder that can be used to configure and create a SESClient.

cloneReceiptRuleSet

default CloneReceiptRuleSetResponse cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
                                                 throws RuleSetDoesNotExistException,
                                                        AlreadyExistsException,
                                                        LimitExceededException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the CloneReceiptRuleSet operation returned by the service.

Throws:

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.

LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createConfigurationSet

default CreateConfigurationSetResponse createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
                                                       throws ConfigurationSetAlreadyExistsException,
                                                              InvalidConfigurationSetException,
                                                              LimitExceededException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

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.

InvalidConfigurationSetException - Indicates that the configuration set is invalid. See the error message for details.

LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createConfigurationSetEventDestination

default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
                                                                                       throws ConfigurationSetDoesNotExistException,
                                                                                              EventDestinationAlreadyExistsException,
                                                                                              InvalidCloudWatchDestinationException,
                                                                                              InvalidFirehoseDestinationException,
                                                                                              LimitExceededException,
                                                                                              SdkBaseException,
                                                                                              SdkClientException,
                                                                                              SESException

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 either Amazon CloudWatch or Amazon Kinesis Firehose.

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the CreateConfigurationSetEventDestination operation returned by the service.

Throws:

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

EventDestinationAlreadyExistsException - Indicates that the event destination could not be created because of a naming conflict.

InvalidCloudWatchDestinationException - Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

InvalidFirehoseDestinationException - Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createReceiptFilter

default CreateReceiptFilterResponse createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
                                                 throws LimitExceededException,
                                                        AlreadyExistsException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        SESException

Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

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 Amazon SES Developer Guide.

AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createReceiptRule

default CreateReceiptRuleResponse createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
                                             throws InvalidSnsTopicException,
                                                    InvalidS3ConfigurationException,
                                                    InvalidLambdaFunctionException,
                                                    AlreadyExistsException,
                                                    RuleDoesNotExistException,
                                                    RuleSetDoesNotExistException,
                                                    LimitExceededException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    SESException

Creates a receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

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 Amazon SES Developer Guide.

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 Amazon SES Developer Guide.

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 Amazon SES Developer Guide.

AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.

RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createReceiptRuleSet

default CreateReceiptRuleSetResponse createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
                                                   throws AlreadyExistsException,
                                                          LimitExceededException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          SESException

Creates an empty receipt rule set.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the CreateReceiptRuleSet operation returned by the service.

Throws:

AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.

LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteConfigurationSet

default DeleteConfigurationSetResponse deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
                                                       throws ConfigurationSetDoesNotExistException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DeleteConfigurationSet operation returned by the service.

Throws:

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
                                                                                       throws ConfigurationSetDoesNotExistException,
                                                                                              EventDestinationDoesNotExistException,
                                                                                              SdkBaseException,
                                                                                              SdkClientException,
                                                                                              SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DeleteConfigurationSetEventDestination operation returned by the service.

Throws:

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

EventDestinationDoesNotExistException - Indicates that the event destination does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteIdentity

default DeleteIdentityResponse deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              SESException

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

This action is throttled at one request per second.

Parameters:

deleteIdentityRequest - Represents a request to delete one of your Amazon SES identities (an email address or domain).

Returns:

Result of the DeleteIdentity operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

deleteIdentityPolicy

default DeleteIdentityPolicyResponse deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
                                                   throws SdkBaseException,
                                                          SdkClientException,
                                                          SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DeleteIdentityPolicy operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

deleteReceiptFilter

default DeleteReceiptFilterResponse deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        SESException

Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DeleteReceiptFilter operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

deleteReceiptRule

default DeleteReceiptRuleResponse deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
                                             throws RuleSetDoesNotExistException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    SESException

Deletes the specified receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DeleteReceiptRule operation returned by the service.

Throws:

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteReceiptRuleSet

default DeleteReceiptRuleSetResponse deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
                                                   throws CannotDeleteException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DeleteReceiptRuleSet operation returned by the service.

Throws:

CannotDeleteException - Indicates that the delete operation could not be completed.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteVerifiedEmailAddress

default DeleteVerifiedEmailAddressResponse deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
                                                               throws SdkBaseException,
                                                                      SdkClientException,
                                                                      SESException

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

The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.

This action is throttled at one request per second.

Parameters:

deleteVerifiedEmailAddressRequest - Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account.

Returns:

Result of the DeleteVerifiedEmailAddress operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

describeActiveReceiptRuleSet

default DescribeActiveReceiptRuleSetResponse describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
                                                                   throws SdkBaseException,
                                                                          SdkClientException,
                                                                          SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DescribeActiveReceiptRuleSet operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

describeConfigurationSet

default DescribeConfigurationSetResponse describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)
                                                           throws ConfigurationSetDoesNotExistException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  SESException

Returns the details of the specified configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DescribeConfigurationSet operation returned by the service.

Throws:

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeReceiptRule

default DescribeReceiptRuleResponse describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
                                                 throws RuleDoesNotExistException,
                                                        RuleSetDoesNotExistException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        SESException

Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DescribeReceiptRule operation returned by the service.

Throws:

RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeReceiptRuleSet

default DescribeReceiptRuleSetResponse describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
                                                       throws RuleSetDoesNotExistException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              SESException

Returns the details of the specified receipt rule set.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the DescribeReceiptRuleSet operation returned by the service.

Throws:

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getIdentityDkimAttributes

default GetIdentityDkimAttributesResponse getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
                                                             throws SdkBaseException,
                                                                    SdkClientException,
                                                                    SESException

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

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

• Whether Easy DKIM signing is enabled or disabled.

• A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

• Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This action is throttled at one request per second 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.

Parameters:

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.

Returns:

Result of the GetIdentityDkimAttributes operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

getIdentityMailFromDomainAttributes

default GetIdentityMailFromDomainAttributesResponse getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
                                                                                 throws SdkBaseException,
                                                                                        SdkClientException,
                                                                                        SESException

Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).

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.

Parameters:

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.

Returns:

Result of the GetIdentityMailFromDomainAttributes operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

getIdentityNotificationAttributes

default GetIdentityNotificationAttributesResponse getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
                                                                             throws SdkBaseException,
                                                                                    SdkClientException,
                                                                                    SESException

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This action is throttled at one request per second 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.

Parameters:

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.

Returns:

Result of the GetIdentityNotificationAttributes operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

getIdentityPolicies

default GetIdentityPoliciesResponse getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the GetIdentityPolicies operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

getIdentityVerificationAttributes

default GetIdentityVerificationAttributesResponse getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest)
                                                                             throws SdkBaseException,
                                                                                    SdkClientException,
                                                                                    SESException

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

Parameters:

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.

Returns:

Result of the GetIdentityVerificationAttributes operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

getSendQuota

default GetSendQuotaResponse getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
                                   throws SdkBaseException,
                                          SdkClientException,
                                          SESException

Returns the user's current sending limits.

This action is throttled at one request per second.

Parameters:

getSendQuotaRequest -

Returns:

Result of the GetSendQuota operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

getSendStatistics

default GetSendStatisticsResponse getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
                                             throws SdkBaseException,
                                                    SdkClientException,
                                                    SESException

Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.

Each data point in the list contains statistics for a 15-minute interval.

This action is throttled at one request per second.

Parameters:

getSendStatisticsRequest -

Returns:

Result of the GetSendStatistics operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

listConfigurationSets

default ListConfigurationSetsResponse listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
                                                     throws SdkBaseException,
                                                            SdkClientException,
                                                            SESException

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

This action is throttled at one request per second and can return up to 50 configuration sets at a time.

Parameters:

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 Amazon SES Developer Guide.

Returns:

Result of the ListConfigurationSets operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

listIdentities

default ListIdentitiesResponse listIdentities(ListIdentitiesRequest listIdentitiesRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              SESException

Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the ListIdentities operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

listIdentityPolicies

default ListIdentityPoliciesResponse listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
                                                   throws SdkBaseException,
                                                          SdkClientException,
                                                          SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the ListIdentityPolicies operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

listReceiptFilters

default ListReceiptFiltersResponse listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
                                               throws SdkBaseException,
                                                      SdkClientException,
                                                      SESException

Lists the IP address filters associated with your AWS account.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the ListReceiptFilters operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

listReceiptRuleSets

default ListReceiptRuleSetsResponse listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        SESException

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

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the ListReceiptRuleSets operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

listVerifiedEmailAddresses

default ListVerifiedEmailAddressesResponse listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
                                                               throws SdkBaseException,
                                                                      SdkClientException,
                                                                      SESException

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

The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.

This action is throttled at one request per second.

Parameters:

listVerifiedEmailAddressesRequest -

Returns:

Result of the ListVerifiedEmailAddresses operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

putIdentityPolicy

default PutIdentityPolicyResponse putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
                                             throws InvalidPolicyException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

reorderReceiptRuleSet

default ReorderReceiptRuleSetResponse reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
                                                     throws RuleSetDoesNotExistException,
                                                            RuleDoesNotExistException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the ReorderReceiptRuleSet operation returned by the service.

Throws:

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

sendBounce

default SendBounceResponse sendBounce(SendBounceRequest sendBounceRequest)
                               throws MessageRejectedException,
                                      SdkBaseException,
                                      SdkClientException,
                                      SESException

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.

This action is throttled at one request per second.

Parameters:

sendBounceRequest - Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

Returns:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

sendEmail

default SendEmailResponse sendEmail(SendEmailRequest sendEmailRequest)
                             throws MessageRejectedException,
                                    MailFromDomainNotVerifiedException,
                                    ConfigurationSetDoesNotExistException,
                                    SdkBaseException,
                                    SdkClientException,
                                    SESException

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

There are several important points to know about SendEmail:

• 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 Amazon SES Developer Guide.

• The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

• Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

• For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

Parameters:

sendEmailRequest - Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

Returns:

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.

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 Amazon SES Developer Guide.

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

sendRawEmail

default SendRawEmailResponse sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
                                   throws MessageRejectedException,
                                          MailFromDomainNotVerifiedException,
                                          ConfigurationSetDoesNotExistException,
                                          SdkBaseException,
                                          SdkClientException,
                                          SESException

Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.

There are several important points to know about SendRawEmail:

• 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 Amazon SES Developer Guide.

• The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

• Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

• The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.

• Amazon SES overrides any Message-ID and Date headers you provide.

• For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

• 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

  Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

  For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

sendRawEmailRequest - Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.

Returns:

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.

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 Amazon SES Developer Guide.

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

setActiveReceiptRuleSet

default SetActiveReceiptRuleSetResponse setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
                                                         throws RuleSetDoesNotExistException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the SetActiveReceiptRuleSet operation returned by the service.

Throws:

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

setIdentityDkimEnabled

default SetIdentityDkimEnabledResponse setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
                                                       throws SdkBaseException,
                                                              SdkClientException,
                                                              SESException

Enables or disables Easy DKIM signing of email sent from an identity:

• If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com).

• If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.

This action is throttled at one request per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

Parameters:

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

Returns:

Result of the SetIdentityDkimEnabled operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

setIdentityFeedbackForwardingEnabled

default SetIdentityFeedbackForwardingEnabledResponse setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest)
                                                                                   throws SdkBaseException,
                                                                                          SdkClientException,
                                                                                          SESException

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.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Parameters:

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

Returns:

Result of the SetIdentityFeedbackForwardingEnabled operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

setIdentityHeadersInNotificationsEnabled

default SetIdentityHeadersInNotificationsEnabledResponse setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest)
                                                                                           throws SdkBaseException,
                                                                                                  SdkClientException,
                                                                                                  SESException

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.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Parameters:

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.

Returns:

Result of the SetIdentityHeadersInNotificationsEnabled operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

setIdentityMailFromDomain

default SetIdentityMailFromDomainResponse setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
                                                             throws SdkBaseException,
                                                                    SdkClientException,
                                                                    SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the SetIdentityMailFromDomain operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

setIdentityNotificationTopic

default SetIdentityNotificationTopicResponse setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)
                                                                   throws SdkBaseException,
                                                                          SdkClientException,
                                                                          SESException

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

Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.

This action is throttled at one request per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

Parameters:

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

Returns:

Result of the SetIdentityNotificationTopic operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

setReceiptRulePosition

default SetReceiptRulePositionResponse setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)
                                                       throws RuleSetDoesNotExistException,
                                                              RuleDoesNotExistException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              SESException

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.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the SetReceiptRulePosition operation returned by the service.

Throws:

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
                                                                                       throws ConfigurationSetDoesNotExistException,
                                                                                              EventDestinationDoesNotExistException,
                                                                                              InvalidCloudWatchDestinationException,
                                                                                              InvalidFirehoseDestinationException,
                                                                                              SdkBaseException,
                                                                                              SdkClientException,
                                                                                              SESException

Updates the event destination of a configuration set.

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.

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 Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the UpdateConfigurationSetEventDestination operation returned by the service.

Throws:

ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.

EventDestinationDoesNotExistException - Indicates that the event destination does not exist.

InvalidCloudWatchDestinationException - Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

InvalidFirehoseDestinationException - Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateReceiptRule

default UpdateReceiptRuleResponse updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)
                                             throws InvalidSnsTopicException,
                                                    InvalidS3ConfigurationException,
                                                    InvalidLambdaFunctionException,
                                                    RuleSetDoesNotExistException,
                                                    RuleDoesNotExistException,
                                                    LimitExceededException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    SESException

Updates a receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

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.

Returns:

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 Amazon SES Developer Guide.

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 Amazon SES Developer Guide.

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 Amazon SES Developer Guide.

RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.

RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.

LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SESException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

verifyDomainDkim

default VerifyDomainDkimResponse verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)
                                           throws SdkBaseException,
                                                  SdkClientException,
                                                  SESException

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.

This action is throttled at one request per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.

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

Parameters:

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

Returns:

Result of the VerifyDomainDkim operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

verifyDomainIdentity

default VerifyDomainIdentityResponse verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
                                                   throws SdkBaseException,
                                                          SdkClientException,
                                                          SESException

Verifies a domain.

This action is throttled at one request per second.

Parameters:

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.

Returns:

Result of the VerifyDomainIdentity operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

verifyEmailAddress

default VerifyEmailAddressResponse verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
                                               throws SdkBaseException,
                                                      SdkClientException,
                                                      SESException

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.

This action is throttled at one request per second.

Parameters:

verifyEmailAddressRequest - Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

Returns:

Result of the VerifyEmailAddress operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

verifyEmailIdentity

default VerifyEmailIdentityResponse verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        SESException

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

This action is throttled at one request per second.

Parameters:

verifyEmailIdentityRequest - Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

Returns:

Result of the VerifyEmailIdentity operation returned by the service.

Throws:

SdkBaseException

SdkClientException

SESException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()

waiters

SESClientWaiters waiters()