public interface AmazonSimpleEmailService
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 .
NOTE:For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
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()
Returns the metadata and receipt rules for the receipt rule set that
is currently active.
|
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.
|
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()
Returns the user's current sending limits.
|
GetSendQuotaResult |
getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Returns the user's current sending limits.
|
GetSendStatisticsResult |
getSendStatistics()
Returns the user's sending statistics.
|
GetSendStatisticsResult |
getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Returns the user's sending statistics.
|
ListIdentitiesResult |
listIdentities()
Returns a list containing all of the identities (email addresses and
domains) for a specific AWS Account, regardless of verification
status.
|
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()
Lists the IP address filters associated with your account.
|
ListReceiptFiltersResult |
listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your account.
|
ListReceiptRuleSetsResult |
listReceiptRuleSets()
Lists the receipt rule sets that exist under your AWS account.
|
ListReceiptRuleSetsResult |
listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your AWS account.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses()
Returns a list containing all of the email addresses that have been
verified.
|
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()
Sets the specified receipt rule set as the active receipt rule set.
|
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.
|
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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
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.
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.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
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.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified identity (email address or domain) from the list of verified identities.
This action is throttled at one request per second.
deleteIdentityRequest
- Container for the necessary parameters to
execute the DeleteIdentity service method on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest) throws AmazonServiceException, AmazonClientException
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.
updateReceiptRuleRequest
- Container for the necessary parameters
to execute the UpdateReceiptRule service method on
AmazonSimpleEmailService.LimitExceededException
InvalidS3ConfigurationException
RuleSetDoesNotExistException
InvalidLambdaFunctionException
RuleDoesNotExistException
InvalidSnsTopicException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) throws AmazonServiceException, AmazonClientException
Returns a list containing all of the email addresses that have been verified.
IMPORTANT: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.
listVerifiedEmailAddressesRequest
- Container for the necessary
parameters to execute the ListVerifiedEmailAddresses service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest) throws AmazonServiceException, AmazonClientException
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.
deleteReceiptRuleRequest
- Container for the necessary parameters
to execute the DeleteReceiptRule service method on
AmazonSimpleEmailService.RuleSetDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest) throws AmazonServiceException, AmazonClientException
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.
verifyEmailIdentityRequest
- Container for the necessary
parameters to execute the VerifyEmailIdentity service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) throws AmazonServiceException, AmazonClientException
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 .
getIdentityNotificationAttributesRequest
- Container for the
necessary parameters to execute the GetIdentityNotificationAttributes
service method on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) throws AmazonServiceException, AmazonClientException
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 .
verifyDomainDkimRequest
- Container for the necessary parameters
to execute the VerifyDomainDkim service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) throws AmazonServiceException, AmazonClientException
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:
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 .
getIdentityDkimAttributesRequest
- Container for the necessary
parameters to execute the GetIdentityDkimAttributes service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
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.
describeReceiptRuleSetRequest
- Container for the necessary
parameters to execute the DescribeReceiptRuleSet service method on
AmazonSimpleEmailService.RuleSetDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.void verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) throws AmazonServiceException, AmazonClientException
Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
IMPORTANT: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.
verifyEmailAddressRequest
- Container for the necessary
parameters to execute the VerifyEmailAddress service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest) throws AmazonServiceException, AmazonClientException
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
.
NOTE: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.
listIdentityPoliciesRequest
- Container for the necessary
parameters to execute the ListIdentityPolicies service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest) throws AmazonServiceException, AmazonClientException
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.
listIdentitiesRequest
- Container for the necessary parameters to
execute the ListIdentities service method on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest) throws AmazonServiceException, AmazonClientException
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.
getIdentityVerificationAttributesRequest
- Container for the
necessary parameters to execute the GetIdentityVerificationAttributes
service method on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: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 .
setIdentityFeedbackForwardingEnabledRequest
- Container for the
necessary parameters to execute the
SetIdentityFeedbackForwardingEnabled service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
Reorders the receipt rules within a receipt rule set.
NOTE: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.
reorderReceiptRuleSetRequest
- Container for the necessary
parameters to execute the ReorderReceiptRuleSet service method on
AmazonSimpleEmailService.RuleSetDoesNotExistException
RuleDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest) throws AmazonServiceException, AmazonClientException
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.
deleteReceiptFilterRequest
- Container for the necessary
parameters to execute the DeleteReceiptFilter service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest) throws AmazonServiceException, AmazonClientException
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.
describeReceiptRuleRequest
- Container for the necessary
parameters to execute the DescribeReceiptRule service method on
AmazonSimpleEmailService.RuleSetDoesNotExistException
RuleDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest) throws AmazonServiceException, AmazonClientException
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.
setReceiptRulePositionRequest
- Container for the necessary
parameters to execute the SetReceiptRulePosition service method on
AmazonSimpleEmailService.RuleSetDoesNotExistException
RuleDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest) throws AmazonServiceException, AmazonClientException
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.
listReceiptFiltersRequest
- Container for the necessary
parameters to execute the ListReceiptFilters service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest) throws AmazonServiceException, AmazonClientException
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.
createReceiptFilterRequest
- Container for the necessary
parameters to execute the CreateReceiptFilter service method on
AmazonSimpleEmailService.AlreadyExistsException
LimitExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) throws AmazonServiceException, AmazonClientException
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.
getSendStatisticsRequest
- Container for the necessary parameters
to execute the GetSendStatistics service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
Sets the specified receipt rule set as the active receipt rule set.
NOTE: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.
setActiveReceiptRuleSetRequest
- Container for the necessary
parameters to execute the SetActiveReceiptRuleSet service method on
AmazonSimpleEmailService.RuleSetDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
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.
describeActiveReceiptRuleSetRequest
- Container for the necessary
parameters to execute the DescribeActiveReceiptRuleSet service method
on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest) throws AmazonServiceException, AmazonClientException
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
:
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
IMPORTANT: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 theSourceIdentityArn
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
.sendRawEmailRequest
- Container for the necessary parameters to
execute the SendRawEmail service method on AmazonSimpleEmailService.MessageRejectedException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest) throws AmazonServiceException, AmazonClientException
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.
createReceiptRuleRequest
- Container for the necessary parameters
to execute the CreateReceiptRule service method on
AmazonSimpleEmailService.AlreadyExistsException
LimitExceededException
InvalidS3ConfigurationException
RuleSetDoesNotExistException
InvalidLambdaFunctionException
RuleDoesNotExistException
InvalidSnsTopicException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified receipt rule set and all of the receipt rules it contains.
NOTE: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.
deleteReceiptRuleSetRequest
- Container for the necessary
parameters to execute the DeleteReceiptRuleSet service method on
AmazonSimpleEmailService.CannotDeleteException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest) throws AmazonServiceException, AmazonClientException
Adds or updates a sending authorization policy for the specified identity (email address or domain).
NOTE: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.
putIdentityPolicyRequest
- Container for the necessary parameters
to execute the PutIdentityPolicy service method on
AmazonSimpleEmailService.InvalidPolicyException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: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.
getIdentityPoliciesRequest
- Container for the necessary
parameters to execute the GetIdentityPolicies service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) throws AmazonServiceException, AmazonClientException
Enables or disables Easy DKIM signing of email sent from an identity:
example.com
), then Amazon SES will DKIM-sign all email
sent by addresses under that domain name (e.g.,
[email protected]
).
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 .
setIdentityDkimEnabledRequest
- Container for the necessary
parameters to execute the SetIdentityDkimEnabled service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest) throws AmazonServiceException, AmazonClientException
Returns the user's current sending limits.
This action is throttled at one request per second.
getSendQuotaRequest
- Container for the necessary parameters to
execute the GetSendQuota service method on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: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.
deleteIdentityPolicyRequest
- Container for the necessary
parameters to execute the DeleteIdentityPolicy service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest) throws AmazonServiceException, AmazonClientException
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.
listReceiptRuleSetsRequest
- Container for the necessary
parameters to execute the ListReceiptRuleSets service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SendEmailResult sendEmail(SendEmailRequest sendEmailRequest) throws AmazonServiceException, AmazonClientException
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
:
sendEmailRequest
- Container for the necessary parameters to
execute the SendEmail service method on AmazonSimpleEmailService.MessageRejectedException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest) throws AmazonServiceException, AmazonClientException
Verifies a domain.
This action is throttled at one request per second.
verifyDomainIdentityRequest
- Container for the necessary
parameters to execute the VerifyDomainIdentity service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) throws AmazonServiceException, AmazonClientException
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
.
NOTE: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 .
setIdentityNotificationTopicRequest
- Container for the necessary
parameters to execute the SetIdentityNotificationTopic service method
on AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.void deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified email address from the list of verified addresses.
IMPORTANT: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.
deleteVerifiedEmailAddressRequest
- Container for the necessary
parameters to execute the DeleteVerifiedEmailAddress service method on
AmazonSimpleEmailService.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
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.
cloneReceiptRuleSetRequest
- Container for the necessary
parameters to execute the CloneReceiptRuleSet service method on
AmazonSimpleEmailService.AlreadyExistsException
LimitExceededException
RuleSetDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SendBounceResult sendBounce(SendBounceRequest sendBounceRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: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.
sendBounceRequest
- Container for the necessary parameters to
execute the SendBounce service method on AmazonSimpleEmailService.MessageRejectedException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest) throws AmazonServiceException, AmazonClientException
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.
createReceiptRuleSetRequest
- Container for the necessary
parameters to execute the CreateReceiptRuleSet service method on
AmazonSimpleEmailService.AlreadyExistsException
LimitExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListVerifiedEmailAddressesResult listVerifiedEmailAddresses() throws AmazonServiceException, AmazonClientException
Returns a list containing all of the email addresses that have been verified.
IMPORTANT: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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListIdentitiesResult listIdentities() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListReceiptFiltersResult listReceiptFilters() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetSendStatisticsResult getSendStatistics() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.SetActiveReceiptRuleSetResult setActiveReceiptRuleSet() throws AmazonServiceException, AmazonClientException
Sets the specified receipt rule set as the active receipt rule set.
NOTE: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.
RuleSetDoesNotExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.GetSendQuotaResult getSendQuota() throws AmazonServiceException, AmazonClientException
Returns the user's current sending limits.
This action is throttled at one request per second.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.ListReceiptRuleSetsResult listReceiptRuleSets() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonSimpleEmailService indicating
either a problem with the data in the request, or a server side issue.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.Copyright © 2015. All rights reserved.