@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSimpleEmailService
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSimpleEmailService instead.
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
This documentation contains reference information related to the following:
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CloneReceiptRuleSetResult |
cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one.
|
CreateConfigurationSetResult |
createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Creates a configuration set.
|
CreateConfigurationSetEventDestinationResult |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Creates a configuration set event destination.
|
CreateConfigurationSetTrackingOptionsResult |
createConfigurationSetTrackingOptions(CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest)
Creates an association between a configuration set and a custom domain for open and click event tracking.
|
CreateCustomVerificationEmailTemplateResult |
createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest)
Creates a new custom verification email template.
|
CreateReceiptFilterResult |
createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
Creates a new IP address filter.
|
CreateReceiptRuleResult |
createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
Creates a receipt rule.
|
CreateReceiptRuleSetResult |
createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
Creates an empty receipt rule set.
|
CreateTemplateResult |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates an email template.
|
DeleteConfigurationSetResult |
deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Deletes a configuration set.
|
DeleteConfigurationSetEventDestinationResult |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Deletes a configuration set event destination.
|
DeleteConfigurationSetTrackingOptionsResult |
deleteConfigurationSetTrackingOptions(DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest)
Deletes an association between a configuration set and a custom domain for open and click event tracking.
|
DeleteCustomVerificationEmailTemplateResult |
deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest)
Deletes an existing custom verification email template.
|
DeleteIdentityResult |
deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (an email address or a domain) from the list of verified identities.
|
DeleteIdentityPolicyResult |
deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
|
DeleteReceiptFilterResult |
deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
Deletes the specified IP address filter.
|
DeleteReceiptRuleResult |
deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
Deletes the specified receipt rule.
|
DeleteReceiptRuleSetResult |
deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it contains.
|
DeleteTemplateResult |
deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes an email template.
|
DeleteVerifiedEmailAddressResult |
deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deprecated.
|
DescribeActiveReceiptRuleSetResult |
describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
Returns the metadata and receipt rules for the receipt rule set that is currently active.
|
DescribeConfigurationSetResult |
describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)
Returns the details of the specified configuration set.
|
DescribeReceiptRuleResult |
describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
|
DescribeReceiptRuleSetResult |
describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
|
GetAccountSendingEnabledResult |
getAccountSendingEnabled(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest)
Returns the email sending status of the Amazon SES account for the current Region.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCustomVerificationEmailTemplateResult |
getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest)
Returns the custom email verification template for the template name you specify.
|
GetIdentityDkimAttributesResult |
getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity.
|
GetIdentityMailFromDomainAttributesResult |
getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
|
GetIdentityNotificationAttributesResult |
getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity
notification attributes.
|
GetIdentityPoliciesResult |
getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
Returns the requested sending authorization policies for the given identity (an email address or a domain).
|
GetIdentityVerificationAttributesResult |
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.
|
GetSendQuotaResult |
getSendQuota()
Simplified method form for invoking the GetSendQuota operation.
|
GetSendQuotaResult |
getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Provides the sending limits for the Amazon SES account.
|
GetSendStatisticsResult |
getSendStatistics()
Simplified method form for invoking the GetSendStatistics operation.
|
GetSendStatisticsResult |
getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Provides sending statistics for the current Amazon Web Services Region.
|
GetTemplateResult |
getTemplate(GetTemplateRequest getTemplateRequest)
Displays the template object (which includes the Subject line, HTML part and text part) for the template you
specify.
|
ListConfigurationSetsResult |
listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web
Services Region.
|
ListCustomVerificationEmailTemplatesResult |
listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest)
Lists the existing custom verification email templates for your account in the current Amazon Web Services
Region.
|
ListIdentitiesResult |
listIdentities()
Simplified method form for invoking the ListIdentities operation.
|
ListIdentitiesResult |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services
account in the current Amazon Web Services Region, regardless of verification status.
|
ListIdentityPoliciesResult |
listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain).
|
ListReceiptFiltersResult |
listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services
Region.
|
ListReceiptRuleSetsResult |
listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services
Region.
|
ListTemplatesResult |
listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses()
Simplified method form for invoking the ListVerifiedEmailAddresses operation.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Deprecated.
|
PutConfigurationSetDeliveryOptionsResult |
putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)
Adds or updates the delivery options for a configuration set.
|
PutIdentityPolicyResult |
putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
|
ReorderReceiptRuleSetResult |
reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
Reorders the receipt rules within a receipt rule set.
|
SendBounceResult |
sendBounce(SendBounceRequest sendBounceRequest)
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
|
SendBulkTemplatedEmailResult |
sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest)
Composes an email message to multiple destinations.
|
SendCustomVerificationEmailResult |
sendCustomVerificationEmail(SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest)
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services
Region and attempts to verify it.
|
SendEmailResult |
sendEmail(SendEmailRequest sendEmailRequest)
Composes an email message and immediately queues it for sending.
|
SendRawEmailResult |
sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
Composes an email message and immediately queues it for sending.
|
SendTemplatedEmailResult |
sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest)
Composes an email message using an email template and immediately queues it for sending.
|
SetActiveReceiptRuleSetResult |
setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
Sets the specified receipt rule set as the active receipt rule set.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetIdentityDkimEnabledResult |
setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
Enables or disables Easy DKIM signing of email sent from an identity.
|
SetIdentityFeedbackForwardingEnabledResult |
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.
|
SetIdentityHeadersInNotificationsEnabledResult |
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.
|
SetIdentityMailFromDomainResult |
setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
|
SetIdentityNotificationTopicResult |
setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications.
|
SetReceiptRulePositionResult |
setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)
Sets the position of the specified receipt rule in the receipt rule set.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TestRenderTemplateResult |
testRenderTemplate(TestRenderTemplateRequest testRenderTemplateRequest)
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
|
UpdateAccountSendingEnabledResult |
updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest)
Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services
Region.
|
UpdateConfigurationSetEventDestinationResult |
updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Updates the event destination of a configuration set.
|
UpdateConfigurationSetReputationMetricsEnabledResult |
updateConfigurationSetReputationMetricsEnabled(UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest)
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a
given Amazon Web Services Region.
|
UpdateConfigurationSetSendingEnabledResult |
updateConfigurationSetSendingEnabled(UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest)
Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web
Services Region.
|
UpdateConfigurationSetTrackingOptionsResult |
updateConfigurationSetTrackingOptions(UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest)
Modifies an association between a configuration set and a custom domain for open and click event tracking.
|
UpdateCustomVerificationEmailTemplateResult |
updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest)
Updates an existing custom verification email template.
|
UpdateReceiptRuleResult |
updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)
Updates a receipt rule.
|
UpdateTemplateResult |
updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates an email template.
|
VerifyDomainDkimResult |
verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)
Returns a set of DKIM tokens for a domain identity.
|
VerifyDomainIdentityResult |
verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and
attempts to verify it.
|
VerifyEmailAddressResult |
verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
Deprecated.
|
VerifyEmailIdentityResult |
verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services
Region and attempts to verify it.
|
AmazonSimpleEmailServiceWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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 ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
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 void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CloneReceiptRuleSetRequest request = new CloneReceiptRuleSetRequest().withRuleSetName("RuleSetToCreate").withOriginalRuleSetName("RuleSetToClone");
CloneReceiptRuleSetResult response = client.cloneReceiptRuleSet(request);CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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 Amazon Web
Services 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.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.InvalidSNSDestinationException - Indicates that the Amazon Simple Notification Service (Amazon SNS) 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.CreateConfigurationSetTrackingOptionsResult createConfigurationSetTrackingOptions(CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest)
Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
createConfigurationSetTrackingOptionsRequest - Represents a request to create an open and click tracking option object in a configuration set.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.TrackingOptionsAlreadyExistsException - Indicates that the configuration set you specified already contains a TrackingOptions object.InvalidTrackingOptionsException - Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error
appears most often in the following situations:
When the tracking domain you specified is not verified in Amazon SES.
When the tracking domain you specified is not a valid domain or subdomain.
CreateCustomVerificationEmailTemplateResult createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest)
Creates a new custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
createCustomVerificationEmailTemplateRequest - Represents a request to create a custom verification email template.CustomVerificationEmailTemplateAlreadyExistsException - Indicates that a custom verification email template with the name you specified already exists.FromEmailAddressNotVerifiedException - Indicates that the sender address specified for a custom verification email is not verified, and is
therefore not eligible to send the custom verification email.CustomVerificationEmailInvalidContentException - Indicates that custom verification email template provided content is invalid.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.CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CreateReceiptFilterRequest request = new CreateReceiptFilterRequest().withFilter(new ReceiptFilter().withName("MyFilter").withIpFilter(
new ReceiptIpFilter().withPolicy("Allow").withCidr("1.2.3.4/24")));
CreateReceiptFilterResult response = client.createReceiptFilter(request);CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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 Amazon Web Services 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 Amazon Web Services 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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CreateReceiptRuleRequest request = new CreateReceiptRuleRequest()
.withRuleSetName("MyRuleSet")
.withAfter("")
.withRule(
new ReceiptRule().withName("MyRule").withEnabled(true).withTlsPolicy("Optional")
.withActions(new ReceiptAction().withS3Action(new S3Action().withBucketName("MyBucket").withObjectKeyPrefix("email")))
.withScanEnabled(true));
CreateReceiptRuleResult response = client.createReceiptRule(request);CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CreateReceiptRuleSetRequest request = new CreateReceiptRuleSetRequest().withRuleSetName("MyRuleSet");
CreateReceiptRuleSetResult response = client.createReceiptRuleSet(request);CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest)
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
createTemplateRequest - Represents a request to create an email template. For more information, see the Amazon SES Developer
Guide.AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.InvalidTemplateException - Indicates that the template that you specified could not be rendered. This issue may occur when a
template refers to a partial that 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.DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.EventDestinationDoesNotExistException - Indicates that the event destination does not exist.DeleteConfigurationSetTrackingOptionsResult deleteConfigurationSetTrackingOptions(DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest)
Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
deleteConfigurationSetTrackingOptionsRequest - Represents a request to delete open and click tracking options in a configuration set.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.TrackingOptionsDoesNotExistException - Indicates that the TrackingOptions object you specified does not exist.DeleteCustomVerificationEmailTemplateResult deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest)
Deletes an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
deleteCustomVerificationEmailTemplateRequest - Represents a request to delete an existing custom verification email template.DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
deleteIdentityRequest - Represents a request to delete one of your Amazon SES identities (an email address or domain).AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteIdentityRequest request = new DeleteIdentityRequest().withIdentity("[email protected]");
DeleteIdentityResult response = client.deleteIdentity(request);DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy with the specified name does not exist.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteIdentityPolicyRequest request = new DeleteIdentityPolicyRequest().withIdentity("[email protected]").withPolicyName("MyPolicy");
DeleteIdentityPolicyResult response = client.deleteIdentityPolicy(request);DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteReceiptFilterRequest request = new DeleteReceiptFilterRequest().withFilterName("MyFilter");
DeleteReceiptFilterResult response = client.deleteReceiptFilter(request);DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteReceiptRuleRequest request = new DeleteReceiptRuleRequest().withRuleSetName("MyRuleSet").withRuleName("MyRule");
DeleteReceiptRuleResult response = client.deleteReceiptRule(request);DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.CannotDeleteException - Indicates that the delete operation could not be completed.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteReceiptRuleSetRequest request = new DeleteReceiptRuleSetRequest().withRuleSetName("MyRuleSet");
DeleteReceiptRuleSetResult response = client.deleteReceiptRuleSet(request);DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes an email template.
You can execute this operation no more than once per second.
deleteTemplateRequest - Represents a request to delete an email template. For more information, see the Amazon SES Developer
Guide.DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
deleteVerifiedEmailAddressRequest - Represents a request to delete an email address from the list of email addresses you have attempted to
verify under your Amazon Web Services account.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteVerifiedEmailAddressRequest request = new DeleteVerifiedEmailAddressRequest().withEmailAddress("[email protected]");
DeleteVerifiedEmailAddressResult response = client.deleteVerifiedEmailAddress(request);DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); DescribeActiveReceiptRuleSetRequest request = new DescribeActiveReceiptRuleSetRequest(); DescribeActiveReceiptRuleSetResult response = client.describeActiveReceiptRuleSet(request);
DescribeConfigurationSetResult describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)
Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DescribeReceiptRuleRequest request = new DescribeReceiptRuleRequest().withRuleSetName("MyRuleSet").withRuleName("MyRule");
DescribeReceiptRuleResult response = client.describeReceiptRule(request);DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DescribeReceiptRuleSetRequest request = new DescribeReceiptRuleSetRequest().withRuleSetName("MyRuleSet");
DescribeReceiptRuleSetResult response = client.describeReceiptRuleSet(request);GetAccountSendingEnabledResult getAccountSendingEnabled(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest)
Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
getAccountSendingEnabledRequest - AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); GetAccountSendingEnabledRequest request = new GetAccountSendingEnabledRequest(); GetAccountSendingEnabledResult response = client.getAccountSendingEnabled(request);
GetCustomVerificationEmailTemplateResult getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest)
Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
getCustomVerificationEmailTemplateRequest - Represents a request to retrieve an existing custom verification email template.CustomVerificationEmailTemplateDoesNotExistException - Indicates that a custom verification email template with the name you specified does not exist.GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
Whether Easy DKIM signing is enabled or disabled.
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityDkimAttributesRequest request = new GetIdentityDkimAttributesRequest().withIdentities("example.com", "[email protected]");
GetIdentityDkimAttributesResult response = client.getIdentityDkimAttributes(request);GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityMailFromDomainAttributesRequest request = new GetIdentityMailFromDomainAttributesRequest().withIdentities("example.com");
GetIdentityMailFromDomainAttributesResult response = client.getIdentityMailFromDomainAttributes(request);GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityNotificationAttributesRequest request = new GetIdentityNotificationAttributesRequest().withIdentities("example.com");
GetIdentityNotificationAttributesResult response = client.getIdentityNotificationAttributes(request);GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
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 operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityPoliciesRequest request = new GetIdentityPoliciesRequest().withIdentity("example.com").withPolicyNames("MyPolicy");
GetIdentityPoliciesResult response = client.getIdentityPolicies(request);GetIdentityVerificationAttributesResult 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.
The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityVerificationAttributesRequest request = new GetIdentityVerificationAttributesRequest().withIdentities("example.com");
GetIdentityVerificationAttributesResult response = client.getIdentityVerificationAttributes(request);GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
getSendQuotaRequest - AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); GetSendQuotaRequest request = new GetSendQuotaRequest(); GetSendQuotaResult response = client.getSendQuota(request);
GetSendQuotaResult getSendQuota()
getSendQuota(GetSendQuotaRequest)GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
getSendStatisticsRequest - AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); GetSendStatisticsRequest request = new GetSendStatisticsRequest(); GetSendStatisticsResult response = client.getSendStatistics(request);
GetSendStatisticsResult getSendStatistics()
GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)
Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
You can execute this operation no more than once per second.
getTemplateRequest - TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation returns up to 1,000 configuration
sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also
returns NextToken. You can then execute the ListConfigurationSets operation again,
passing the NextToken parameter and the value of the NextToken element to retrieve additional
results.
listConfigurationSetsRequest - Represents a request to list the configuration sets associated with your Amazon Web Services account.
Configuration sets enable you to publish email sending events. For information about using configuration
sets, see the Amazon SES
Developer Guide.ListCustomVerificationEmailTemplatesResult listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest)
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
listCustomVerificationEmailTemplatesRequest - Represents a request to list the existing custom verification email templates for your account.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
It's recommended that for successive pagination calls of this API, you continue to the use the same
parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the
original call and received a NextToken in the response, you should continue providing the
IdentityType=Domain parameter for further NextToken calls; however, if you didn't
provide the IdentityType parameter in the original call, then continue to not provide it for
successive pagination calls. Using this protocol will ensure consistent results.
listIdentitiesRequest - Represents a request to return a list of all identities (email addresses and domains) that you have
attempted to verify under your Amazon Web Services account, regardless of verification status.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListIdentitiesRequest request = new ListIdentitiesRequest().withIdentityType("EmailAddress").withNextToken("").withMaxItems(123);
ListIdentitiesResult response = client.listIdentities(request);ListIdentitiesResult listIdentities()
listIdentities(ListIdentitiesRequest)ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain). This operation returns only a list. To get the actual policy content, use
GetIdentityPolicies.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListIdentityPoliciesRequest request = new ListIdentityPoliciesRequest().withIdentity("example.com");
ListIdentityPoliciesResult response = client.listIdentityPolicies(request);ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
listReceiptFiltersRequest - Represents a request to list the IP address filters that exist under your Amazon Web Services account. You
use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer
Guide.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); ListReceiptFiltersRequest request = new ListReceiptFiltersRequest(); ListReceiptFiltersResult response = client.listReceiptFilters(request);
ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services
Region. If there are additional receipt rule sets to be retrieved, you receive a NextToken that you
can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
listReceiptRuleSetsRequest - Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You
use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer
Guide.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListReceiptRuleSetsRequest request = new ListReceiptRuleSetsRequest().withNextToken("");
ListReceiptRuleSetsResult response = client.listReceiptRuleSets(request);ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
You can execute this operation no more than once per second.
listTemplatesRequest - ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with
your account.
listVerifiedEmailAddressesRequest - AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); ListVerifiedEmailAddressesRequest request = new ListVerifiedEmailAddressesRequest(); ListVerifiedEmailAddressesResult response = client.listVerifiedEmailAddresses(request);
ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)
Adds or updates the delivery options for a configuration set.
putConfigurationSetDeliveryOptionsRequest - A request to modify the delivery options for a configuration set.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.InvalidDeliveryOptionsException - Indicates that provided delivery option is invalid.PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.InvalidPolicyException - Indicates that the provided policy is invalid. Check the error stack for more information about what
caused the error.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
PutIdentityPolicyRequest request = new PutIdentityPolicyRequest()
.withIdentity("example.com")
.withPolicyName("MyPolicy")
.withPolicy(
"{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}");
PutIdentityPolicyResult response = client.putIdentityPolicy(request);ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
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, it is error if the reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ReorderReceiptRuleSetRequest request = new ReorderReceiptRuleSetRequest().withRuleSetName("MyRuleSet").withRuleNames("MyRule", "MyOtherRule");
ReorderReceiptRuleSetResult response = client.reorderReceiptRuleSet(request);SendBounceResult sendBounce(SendBounceRequest sendBounceRequest)
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it.
You cannot use this operation to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
sendBounceRequest - Represents a request to send a bounce message to the sender of an email you received through Amazon SES.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.SendBulkTemplatedEmailResult sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest)
Composes an email message to multiple destinations. The message body is created using an email template.
To send email using this operation, your call must meet the following requirements:
The call must refer to an existing email template. You can create email templates using CreateTemplate.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Each Destination parameter must include at least one recipient email address. The recipient address
can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is
not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the
message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an
email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call
the SendBulkTemplatedEmail operation several times to send the message to each group.
The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.
sendBulkTemplatedEmailRequest - Represents a request to send a templated email to multiple destinations using Amazon SES. For more
information, see the Amazon SES Developer
Guide.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.TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
SendCustomVerificationEmailResult sendCustomVerificationEmail(SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest)
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
sendCustomVerificationEmailRequest - Represents a request to send a custom verification email to a specified recipient.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.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.CustomVerificationEmailTemplateDoesNotExistException - Indicates that a custom verification email template with the name you specified does not exist.FromEmailAddressNotVerifiedException - Indicates that the sender address specified for a custom verification email is not verified, and is
therefore not eligible to send the custom verification email.ProductionAccessNotGrantedException - Indicates that the account has not been granted production access.SendEmailResult sendEmail(SendEmailRequest sendEmailRequest)
Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an
email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call
the SendEmail operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
sendEmailRequest - Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.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.ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SendEmailRequest request = new SendEmailRequest()
.withSource("[email protected]")
.withDestination(
new Destination().withToAddresses("[email protected]", "[email protected]").withCcAddresses("[email protected]")
.withBccAddresses(new ArrayList()))
.withMessage(
new Message()
.withSubject(new Content().withData("Test email").withCharset("UTF-8"))
.withBody(
new Body()
.withText(new Content().withData("This is the message body in text format.").withCharset("UTF-8"))
.withHtml(
new Content()
.withData(
"This message body contains HTML formatting. It can, for example, contain links like this one: Amazon SES Developer Guide.")
.withCharset("UTF-8")))).withReplyToAddresses(new ArrayList()).withReturnPath("")
.withSourceArn("").withReturnPathArn("");
SendEmailResult response = client.sendEmail(request);SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
Composes an email message and immediately queues it for sending.
This operation is more flexible than the SendEmail operation. When you use the
SendRawEmail operation, you can specify the headers of the message as well as its content. This
flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains
both a text and an HTML version). You can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements:
You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.
If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
The maximum message size, including attachments, is 10 MB.
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
Additionally, keep the following considerations in mind when using the SendRawEmail operation:
Although you can customize the message headers when using the SendRawEmail operation, Amazon SES
automatically applies its own Message-ID and Date headers; if you passed these headers
when creating the message, they are overwritten by the values that Amazon SES provides.
If you are using sending authorization to send on behalf of another user, SendRawEmail enables you
to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two
ways: you can pass optional parameters SourceArn, FromArn, and/or
ReturnPathArn, or you can include the following X-headers in the header of your raw email:
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path
addresses to the same identity that you specified.
For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
sendRawEmailRequest - Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.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.ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SendRawEmailRequest request = new SendRawEmailRequest()
.withSource("")
.withDestinations(new ArrayList())
.withRawMessage(
new RawMessage().withData(ByteBuffer
.wrap("From: [email protected]\\nTo: [email protected]\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--"
.getBytes()))).withFromArn("").withSourceArn("").withReturnPathArn("");
SendRawEmailResult response = client.sendRawEmail(request);SendTemplatedEmailResult sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest)
Composes an email message using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Calls to the SendTemplatedEmail operation may only include one Destination parameter. A
destination is a set of recipients that receives the same version of the email. The Destination
parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
The Destination parameter must include at least one recipient email address. The recipient address
can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is
not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the
message contains other recipients that are valid.
If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES
accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains
errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't
return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
sendTemplatedEmailRequest - Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
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 operation with
RuleSetName set to null.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetActiveReceiptRuleSetRequest request = new SetActiveReceiptRuleSetRequest().withRuleSetName("RuleSetToActivate");
SetActiveReceiptRuleSetResult response = client.setActiveReceiptRuleSet(request);SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
For email addresses (for example, [email protected]), you can only enable DKIM signing if the
corresponding domain (in this case, example.com) has been set up to use Easy DKIM.
You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityDkimEnabledRequest request = new SetIdentityDkimEnabledRequest().withIdentity("[email protected]").withDkimEnabled(true);
SetIdentityDkimEnabledResult response = client.setIdentityDkimEnabled(request);SetIdentityFeedbackForwardingEnabledResult 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. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityFeedbackForwardingEnabledRequest request = new SetIdentityFeedbackForwardingEnabledRequest().withIdentity("[email protected]")
.withForwardingEnabled(true);
SetIdentityFeedbackForwardingEnabledResult response = client.setIdentityFeedbackForwardingEnabled(request);SetIdentityHeadersInNotificationsEnabledResult 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.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityHeadersInNotificationsEnabledRequest request = new SetIdentityHeadersInNotificationsEnabledRequest().withIdentity("[email protected]")
.withNotificationType("Bounce").withEnabled(true);
SetIdentityHeadersInNotificationsEnabledResult response = client.setIdentityHeadersInNotificationsEnabled(request);SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
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. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityMailFromDomainRequest request = new SetIdentityMailFromDomainRequest().withIdentity("[email protected]")
.withMailFromDomain("bounces.example.com").withBehaviorOnMXFailure("UseDefaultValue");
SetIdentityMailFromDomainResult response = client.setIdentityMailFromDomain(request);SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
setIdentityNotificationTopicRequest - Represents a request to specify the Amazon SNS topic to which Amazon SES publishes 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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityNotificationTopicRequest request = new SetIdentityNotificationTopicRequest().withIdentity("[email protected]").withNotificationType("Bounce")
.withSnsTopic("arn:aws:sns:us-west-2:111122223333:MyTopic");
SetIdentityNotificationTopicResult response = client.setIdentityNotificationTopic(request);SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)
Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetReceiptRulePositionRequest request = new SetReceiptRulePositionRequest().withRuleSetName("MyRuleSet").withRuleName("RuleToReposition")
.withAfter("PutRuleAfterThisRule");
SetReceiptRulePositionResult response = client.setReceiptRulePosition(request);TestRenderTemplateResult testRenderTemplate(TestRenderTemplateRequest testRenderTemplateRequest)
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
You can execute this operation no more than once per second.
testRenderTemplateRequest - TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.InvalidRenderingParameterException - Indicates that one or more of the replacement values you provided is invalid. This error may occur when
the TemplateData object contains invalid JSON.MissingRenderingAttributeException - Indicates that one or more of the replacement values for the specified template was not specified. Ensure
that the TemplateData object contains references to all of the replacement tags in the specified
template.UpdateAccountSendingEnabledResult updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest)
Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
updateAccountSendingEnabledRequest - Represents a request to enable or disable the email sending capabilities for your entire Amazon SES
account.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build(); UpdateAccountSendingEnabledRequest request = new UpdateAccountSendingEnabledRequest().withEnabled(true); UpdateAccountSendingEnabledResult response = client.updateAccountSendingEnabled(request);
UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
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.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.InvalidSNSDestinationException - Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error
message for details.UpdateConfigurationSetReputationMetricsEnabledResult updateConfigurationSetReputationMetricsEnabled(UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest)
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
updateConfigurationSetReputationMetricsEnabledRequest - Represents a request to modify the reputation metric publishing settings for a configuration set.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateConfigurationSetReputationMetricsEnabledRequest request = new UpdateConfigurationSetReputationMetricsEnabledRequest().withConfigurationSetName(
"foo").withEnabled(true);
UpdateConfigurationSetReputationMetricsEnabledResult response = client.updateConfigurationSetReputationMetricsEnabled(request);UpdateConfigurationSetSendingEnabledResult updateConfigurationSetSendingEnabled(UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest)
Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
updateConfigurationSetSendingEnabledRequest - Represents a request to enable or disable the email sending capabilities for a specific configuration set.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateConfigurationSetSendingEnabledRequest request = new UpdateConfigurationSetSendingEnabledRequest().withConfigurationSetName("foo").withEnabled(
true);
UpdateConfigurationSetSendingEnabledResult response = client.updateConfigurationSetSendingEnabled(request);UpdateConfigurationSetTrackingOptionsResult updateConfigurationSetTrackingOptions(UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest)
Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
updateConfigurationSetTrackingOptionsRequest - Represents a request to update the tracking options for a configuration set.ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.TrackingOptionsDoesNotExistException - Indicates that the TrackingOptions object you specified does not exist.InvalidTrackingOptionsException - Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error
appears most often in the following situations:
When the tracking domain you specified is not verified in Amazon SES.
When the tracking domain you specified is not a valid domain or subdomain.
UpdateCustomVerificationEmailTemplateResult updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest)
Updates an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
updateCustomVerificationEmailTemplateRequest - Represents a request to update an existing custom verification email template.CustomVerificationEmailTemplateDoesNotExistException - Indicates that a custom verification email template with the name you specified does not exist.FromEmailAddressNotVerifiedException - Indicates that the sender address specified for a custom verification email is not verified, and is
therefore not eligible to send the custom verification email.CustomVerificationEmailInvalidContentException - Indicates that custom verification email template provided content is invalid.UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)
Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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 Amazon Web Services 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 Amazon Web Services 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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateReceiptRuleRequest request = new UpdateReceiptRuleRequest().withRuleSetName("MyRuleSet").withRule(
new ReceiptRule().withName("MyRule").withEnabled(true).withTlsPolicy("Optional")
.withActions(new ReceiptAction().withS3Action(new S3Action().withBucketName("MyBucket").withObjectKeyPrefix("email")))
.withScanEnabled(true));
UpdateReceiptRuleResult response = client.updateReceiptRule(request);UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
updateTemplateRequest - TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.InvalidTemplateException - Indicates that the template that you specified could not be rendered. This issue may occur when a
template refers to a partial that does not exist.VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)
Returns a set of DKIM tokens for a domain identity.
When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of
identities that are associated with your account. This is true even if you haven't already associated the domain
with your account by using the VerifyDomainIdentity operation. However, you can't send email from
the domain until you either successfully verify it
or you successfully set up DKIM for it.
You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
Name: token._domainkey.example.com
Type: CNAME
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyDomainDkimRequest request = new VerifyDomainDkimRequest().withDomain("example.com");
VerifyDomainDkimResult response = client.verifyDomainDkim(request);VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyDomainIdentityRequest request = new VerifyDomainIdentityRequest().withDomain("example.com");
VerifyDomainIdentityResult response = client.verifyDomainIdentity(request);VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
verifyEmailAddressRequest - Represents a request to begin email address verification with Amazon SES. For information about email
address verification, see the Amazon SES Developer Guide.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyEmailAddressRequest request = new VerifyEmailAddressRequest().withEmailAddress("[email protected]");
VerifyEmailAddressResult response = client.verifyEmailAddress(request);VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.
You can execute this operation no more than once per second.
verifyEmailIdentityRequest - Represents a request to begin email address verification with Amazon SES. For information about email
address verification, see the Amazon SES Developer Guide.AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyEmailIdentityRequest request = new VerifyEmailIdentityRequest().withEmailAddress("[email protected]");
VerifyEmailIdentityResult response = client.verifyEmailIdentity(request);void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AmazonSimpleEmailServiceWaiters waiters()