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.
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.
|
DeleteVerifiedEmailAddressResult |
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.
|
VerifyEmailAddressResult |
verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
Verifies an email address.
|
VerifyEmailIdentityResult |
verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
Verifies an email address.
|
void setEndpoint(String endpoint)
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.void setRegion(Region region)
setEndpoint(String)
,
sets the regional endpoint for this client's service calls. Callers can
use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
cloneReceiptRuleSetRequest
- 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.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.
createReceiptFilterRequest
- 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.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.
createReceiptRuleRequest
- 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.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.
createReceiptRuleSetRequest
- 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.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.
deleteIdentityRequest
- 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.
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
- 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.
deleteReceiptFilterRequest
- 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.
deleteReceiptRuleRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it contains.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
deleteReceiptRuleSetRequest
- CannotDeleteException
- Indicates that the delete operation could not be completed.DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deletes the specified email address from the list of verified addresses.
This action is throttled at one request per second.
deleteVerifiedEmailAddressRequest
- 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.
describeActiveReceiptRuleSetRequest
- 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.
describeReceiptRuleRequest
- RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.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.
describeReceiptRuleSetRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.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:
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
- 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.
getIdentityMailFromDomainAttributesRequest
- 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.
getIdentityNotificationAttributesRequest
- 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.
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
- 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.
getIdentityVerificationAttributesRequest
- GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Returns the user's current sending limits.
This action is throttled at one request per second.
getSendQuotaRequest
- GetSendQuotaResult getSendQuota()
getSendQuota(GetSendQuotaRequest)
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.
getSendStatisticsRequest
- GetSendStatisticsResult getSendStatistics()
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.
listIdentitiesRequest
- ListIdentitiesResult listIdentities()
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
.
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
- 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.
listReceiptFiltersRequest
- 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.
listReceiptRuleSetsRequest
- ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Returns a list containing all of the email addresses that have been verified.
This action is throttled at one request per second.
listVerifiedEmailAddressesRequest
- ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (email address or domain).
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
- InvalidPolicyException
- Indicates that the provided policy is invalid. Check the error
stack for more information about what caused the error.ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
Reorders the receipt rules within a 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.
reorderReceiptRuleSetRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.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.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
sendBounceRequest
- 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.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
:
sendEmailRequest
- 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.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
:
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
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.sendRawEmailRequest
- 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.SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
Sets the specified receipt rule set as the active 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.
setActiveReceiptRuleSetRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
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
- 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.
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
- SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
Enables or disables the custom MAIL FROM domain setup for a verified identity (email address or domain).
This action is throttled at one request per second.
setIdentityMailFromDomainRequest
- 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
.
SetIdentityFeedbackForwardingEnabled
. This action is throttled at one request per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
setIdentityNotificationTopicRequest
- 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.
setReceiptRulePositionRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.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.
updateReceiptRuleRequest
- 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.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.
verifyDomainDkimRequest
- VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Verifies a domain.
This action is throttled at one request per second.
verifyDomainIdentityRequest
- VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
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.
verifyEmailAddressRequest
- 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.
verifyEmailIdentityRequest
- 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 © 2016. All rights reserved.