com.amazonaws.services.simpleemail

Interface AmazonSimpleEmailService

All Known Subinterfaces:

AmazonSimpleEmailServiceAsync

All Known Implementing Classes:

AbstractAmazonSimpleEmailService, AbstractAmazonSimpleEmailServiceAsync, AmazonSimpleEmailServiceAsyncClient, AmazonSimpleEmailServiceClient

public interface AmazonSimpleEmailService

Interface for accessing Amazon SES.

Amazon Simple Email Service

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

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

Method Summary

Methods

Modifier and Type	Method and Description
CloneReceiptRuleSetResult	cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest) Creates a receipt rule set by cloning an existing one.
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.
DeleteIdentityResult	deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) Deletes the specified identity (email address or domain) from the list of verified identities.
DeleteIdentityPolicyResult	deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (email address or 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.
void	deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) Deletes the specified email address from the list of verified addresses.
DescribeActiveReceiptRuleSetResult	describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest) Returns the metadata and receipt rules for the receipt rule set that is currently active.
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.
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.
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 and/or 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 (email address or 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) Returns the user's current sending limits.
GetSendStatisticsResult	getSendStatistics() Simplified method form for invoking the GetSendStatistics operation.
GetSendStatisticsResult	getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) Returns the user's sending statistics.
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 a specific AWS Account, regardless of verification status.
ListIdentityPoliciesResult	listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (email address or domain).
ListReceiptFiltersResult	listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest) Lists the IP address filters associated with your account.
ListReceiptRuleSetsResult	listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest) Lists the receipt rule sets that exist under your AWS account.
ListVerifiedEmailAddressesResult	listVerifiedEmailAddresses() Simplified method form for invoking the ListVerifiedEmailAddresses operation.
ListVerifiedEmailAddressesResult	listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) Returns a list containing all of the email addresses that have been verified.
PutIdentityPolicyResult	putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (email address or 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.
SendEmailResult	sendEmail(SendEmailRequest sendEmailRequest) Composes an email message based on input data, and then immediately queues the message for sending.
SendRawEmailResult	sendRawEmail(SendRawEmailRequest sendRawEmailRequest) Sends an email message, with header and content specified by the client.
SetActiveReceiptRuleSetResult	setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest) Sets the specified receipt rule set as the active receipt rule set.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://email.us-east-1.amazonaws.com").
SetIdentityDkimEnabledResult	setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity:
SetIdentityFeedbackForwardingEnabledResult	setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.
SetIdentityMailFromDomainResult	setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest) Enables or disables the custom MAIL FROM domain setup for a verified identity (email address or domain).
SetIdentityNotificationTopicResult	setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.
SetReceiptRulePositionResult	setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest) Sets the position of the specified receipt rule in the receipt rule set.
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateReceiptRuleResult	updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest) Updates a receipt rule.
VerifyDomainDkimResult	verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) Returns a set of DKIM tokens for a domain.
VerifyDomainIdentityResult	verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest) Verifies a domain.
void	verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) Verifies an email address.
VerifyEmailIdentityResult	verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest) Verifies an email address.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Overrides the default endpoint for this client ("https://email.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "email.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://email.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "email.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://email.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

An alternative to 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.

Parameters:

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.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

cloneReceiptRuleSet

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.

This action is throttled at one request per second.

Parameters:

cloneReceiptRuleSetRequest -

Returns:

Result of the CloneReceiptRuleSet operation returned by the service.

Throws:

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

AlreadyExistsException - Indicates that a resource could not be created due to a naming conflict.

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

createReceiptFilter

CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)

Creates a new IP address filter.

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

This action is throttled at one request per second.

Parameters:

createReceiptFilterRequest -

Returns:

Result of the CreateReceiptFilter operation returned by the service.

Throws:

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

AlreadyExistsException - Indicates that a resource could not be created due to a naming conflict.

createReceiptRule

CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)

Creates a receipt rule.

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

This action is throttled at one request per second.

Parameters:

createReceiptRuleRequest -

Returns:

Result of the CreateReceiptRule operation returned by the service.

Throws:

InvalidSnsTopicException - Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidS3ConfigurationException - Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidLambdaFunctionException - Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

AlreadyExistsException - Indicates that a resource could not be created due to 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 due to service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

createReceiptRuleSet

CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)

Creates an empty receipt rule set.

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

This action is throttled at one request per second.

Parameters:

createReceiptRuleSetRequest -

Returns:

Result of the CreateReceiptRuleSet operation returned by the service.

Throws:

AlreadyExistsException - Indicates that a resource could not be created due to a naming conflict.

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

deleteIdentity

DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)

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

This action is throttled at one request per second.

Parameters:

deleteIdentityRequest -

Returns:

Result of the DeleteIdentity operation returned by the service.

deleteIdentityPolicy

DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)

Deletes the specified sending authorization policy for the given identity (email address or domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

deleteIdentityPolicyRequest -

Returns:

Result of the DeleteIdentityPolicy operation returned by the service.

deleteReceiptFilter

DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)

Deletes the specified IP address filter.

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

This action is throttled at one request per second.

Parameters:

deleteReceiptFilterRequest -

Returns:

Result of the DeleteReceiptFilter operation returned by the service.

deleteReceiptRule

DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)

Deletes the specified receipt rule.

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

This action is throttled at one request per second.

Parameters:

deleteReceiptRuleRequest -

Returns:

Result of the DeleteReceiptRule operation returned by the service.

Throws:

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

deleteReceiptRuleSet

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.

This action is throttled at one request per second.

Parameters:

deleteReceiptRuleSetRequest -

Returns:

Result of the DeleteReceiptRuleSet operation returned by the service.

Throws:

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

deleteVerifiedEmailAddress

void deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)

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

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

This action is throttled at one request per second.

Parameters:

deleteVerifiedEmailAddressRequest -

describeActiveReceiptRuleSet

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.

This action is throttled at one request per second.

Parameters:

describeActiveReceiptRuleSetRequest -

Returns:

Result of the DescribeActiveReceiptRuleSet operation returned by the service.

describeReceiptRule

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.

This action is throttled at one request per second.

Parameters:

describeReceiptRuleRequest -

Returns:

Result of the DescribeReceiptRule operation returned by the service.

Throws:

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

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

describeReceiptRuleSet

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.

This action is throttled at one request per second.

Parameters:

describeReceiptRuleSetRequest -

Returns:

Result of the DescribeReceiptRuleSet operation returned by the service.

Throws:

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

getIdentityDkimAttributes

GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)

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

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

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

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

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

Parameters:

getIdentityDkimAttributesRequest -

Returns:

Result of the GetIdentityDkimAttributes operation returned by the service.

getIdentityMailFromDomainAttributes

GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)

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

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

Parameters:

getIdentityMailFromDomainAttributesRequest -

Returns:

Result of the GetIdentityMailFromDomainAttributes operation returned by the service.

getIdentityNotificationAttributes

GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)

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

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

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

Parameters:

getIdentityNotificationAttributesRequest -

Returns:

Result of the GetIdentityNotificationAttributes operation returned by the service.

getIdentityPolicies

GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)

Returns the requested sending authorization policies for the given identity (email address or domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

getIdentityPoliciesRequest -

Returns:

Result of the GetIdentityPolicies operation returned by the service.

getIdentityVerificationAttributes

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.

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

Parameters:

getIdentityVerificationAttributesRequest -

Returns:

Result of the GetIdentityVerificationAttributes operation returned by the service.

getSendQuota

GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)

Returns the user's current sending limits.

This action is throttled at one request per second.

Parameters:

getSendQuotaRequest -

Returns:

Result of the GetSendQuota operation returned by the service.

getSendQuota

GetSendQuotaResult getSendQuota()

Simplified method form for invoking the GetSendQuota operation.

See Also:

getSendQuota(GetSendQuotaRequest)

getSendStatistics

GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)

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

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

This action is throttled at one request per second.

Parameters:

getSendStatisticsRequest -

Returns:

Result of the GetSendStatistics operation returned by the service.

getSendStatistics

GetSendStatisticsResult getSendStatistics()

Simplified method form for invoking the GetSendStatistics operation.

See Also:

getSendStatistics(GetSendStatisticsRequest)

listIdentities

ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)

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

This action is throttled at one request per second.

Parameters:

listIdentitiesRequest -

Returns:

Result of the ListIdentities operation returned by the service.

listIdentities

ListIdentitiesResult listIdentities()

Simplified method form for invoking the ListIdentities operation.

See Also:

listIdentities(ListIdentitiesRequest)

listIdentityPolicies

ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)

Returns a list of sending authorization policies that are attached to the given identity (email address or domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

listIdentityPoliciesRequest -

Returns:

Result of the ListIdentityPolicies operation returned by the service.

listReceiptFilters

ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)

Lists the IP address filters associated with your account.

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

This action is throttled at one request per second.

Parameters:

listReceiptFiltersRequest -

Returns:

Result of the ListReceiptFilters operation returned by the service.

listReceiptRuleSets

ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)

Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

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

This action is throttled at one request per second.

Parameters:

listReceiptRuleSetsRequest -

Returns:

Result of the ListReceiptRuleSets operation returned by the service.

listVerifiedEmailAddresses

ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)

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

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

This action is throttled at one request per second.

Parameters:

listVerifiedEmailAddressesRequest -

Returns:

Result of the ListVerifiedEmailAddresses operation returned by the service.

listVerifiedEmailAddresses

ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()

Simplified method form for invoking the ListVerifiedEmailAddresses operation.

See Also:

listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest)

putIdentityPolicy

PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)

Adds or updates a sending authorization policy for the specified identity (email address or domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

putIdentityPolicyRequest -

Returns:

Result of the PutIdentityPolicy operation returned by the service.

Throws:

InvalidPolicyException - Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

reorderReceiptRuleSet

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, this API will return an error if the reorder request doesn't explicitly position all of the rules.

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

This action is throttled at one request per second.

Parameters:

reorderReceiptRuleSetRequest -

Returns:

Result of the ReorderReceiptRuleSet operation returned by the service.

Throws:

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

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

sendBounce

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 API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

sendBounceRequest -

Returns:

Result of the SendBounce operation returned by the service.

Throws:

MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

sendEmail

SendEmailResult sendEmail(SendEmailRequest sendEmailRequest)

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

There are several important points to know about SendEmail:

• You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
• The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
• Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
• For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

Parameters:

sendEmailRequest -

Returns:

Result of the SendEmail operation returned by the service.

Throws:

MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

MailFromDomainNotVerifiedException - Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

sendRawEmail

SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest)

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

There are several important points to know about SendRawEmail:

• You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
• The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
• Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
• The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.
• For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.
• If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:
  • X-SES-SOURCE-ARN
  • X-SES-FROM-ARN
  • X-SES-RETURN-PATH-ARN
  Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

sendRawEmailRequest -

Returns:

Result of the SendRawEmail operation returned by the service.

Throws:

MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

MailFromDomainNotVerifiedException - Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

setActiveReceiptRuleSet

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 API with RuleSetName set to null.

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

This action is throttled at one request per second.

Parameters:

setActiveReceiptRuleSetRequest -

Returns:

Result of the SetActiveReceiptRuleSet operation returned by the service.

Throws:

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

setIdentityDkimEnabled

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 name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., [email protected] ).
• If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

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

This action is throttled at one request per second.

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

Parameters:

setIdentityDkimEnabledRequest -

Returns:

Result of the SetIdentityDkimEnabled operation returned by the service.

setIdentityFeedbackForwardingEnabled

SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest)

Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

This action is throttled at one request per second.

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

Parameters:

setIdentityFeedbackForwardingEnabledRequest -

Returns:

Result of the SetIdentityFeedbackForwardingEnabled operation returned by the service.

setIdentityMailFromDomain

SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)

Enables or disables the custom MAIL FROM domain setup for a verified identity (email address or domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

Parameters:

setIdentityMailFromDomainRequest -

Returns:

Result of the SetIdentityMailFromDomain operation returned by the service.

setIdentityNotificationTopic

SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)

Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

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

This action is throttled at one request per second.

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

Parameters:

setIdentityNotificationTopicRequest -

Returns:

Result of the SetIdentityNotificationTopic operation returned by the service.

setReceiptRulePosition

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.

This action is throttled at one request per second.

Parameters:

setReceiptRulePositionRequest -

Returns:

Result of the SetReceiptRulePosition operation returned by the service.

Throws:

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

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

updateReceiptRule

UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)

Updates a receipt rule.

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

This action is throttled at one request per second.

Parameters:

updateReceiptRuleRequest -

Returns:

Result of the UpdateReceiptRule operation returned by the service.

Throws:

InvalidSnsTopicException - Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidS3ConfigurationException - Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidLambdaFunctionException - Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

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

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

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

verifyDomainDkim

VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)

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

This action is throttled at one request per second.

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

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

Parameters:

verifyDomainDkimRequest -

Returns:

Result of the VerifyDomainDkim operation returned by the service.

verifyDomainIdentity

VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)

Verifies a domain.

This action is throttled at one request per second.

Parameters:

verifyDomainIdentityRequest -

Returns:

Result of the VerifyDomainIdentity operation returned by the service.

verifyEmailAddress

void verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)

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

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

This action is throttled at one request per second.

Parameters:

verifyEmailAddressRequest -

verifyEmailIdentity

VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)

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

This action is throttled at one request per second.

Parameters:

verifyEmailIdentityRequest -

Returns:

Result of the VerifyEmailIdentity operation returned by the service.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.