Class AbstractAmazonSimpleEmailService
- java.lang.Object
-
- com.amazonaws.services.simpleemail.AbstractAmazonSimpleEmailService
-
- All Implemented Interfaces:
AmazonSimpleEmailService
- Direct Known Subclasses:
AbstractAmazonSimpleEmailServiceAsync
public class AbstractAmazonSimpleEmailService extends Object implements AmazonSimpleEmailService
Abstract implementation ofAmazonSimpleEmailService
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAmazonSimpleEmailService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CloneReceiptRuleSetResult
cloneReceiptRuleSet(CloneReceiptRuleSetRequest request)
Creates a receipt rule set by cloning an existing one.CreateReceiptFilterResult
createReceiptFilter(CreateReceiptFilterRequest request)
Creates a new IP address filter.CreateReceiptRuleResult
createReceiptRule(CreateReceiptRuleRequest request)
Creates a receipt rule.CreateReceiptRuleSetResult
createReceiptRuleSet(CreateReceiptRuleSetRequest request)
Creates an empty receipt rule set.DeleteIdentityResult
deleteIdentity(DeleteIdentityRequest request)
Deletes the specified identity (email address or domain) from the list of verified identities.DeleteIdentityPolicyResult
deleteIdentityPolicy(DeleteIdentityPolicyRequest request)
Deletes the specified sending authorization policy for the given identity (email address or domain).DeleteReceiptFilterResult
deleteReceiptFilter(DeleteReceiptFilterRequest request)
Deletes the specified IP address filter.DeleteReceiptRuleResult
deleteReceiptRule(DeleteReceiptRuleRequest request)
Deletes the specified receipt rule.DeleteReceiptRuleSetResult
deleteReceiptRuleSet(DeleteReceiptRuleSetRequest request)
Deletes the specified receipt rule set and all of the receipt rules it contains.DeleteVerifiedEmailAddressResult
deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest request)
Deletes the specified email address from the list of verified addresses.DescribeActiveReceiptRuleSetResult
describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest request)
Returns the metadata and receipt rules for the receipt rule set that is currently active.DescribeReceiptRuleResult
describeReceiptRule(DescribeReceiptRuleRequest request)
Returns the details of the specified receipt rule.DescribeReceiptRuleSetResult
describeReceiptRuleSet(DescribeReceiptRuleSetRequest request)
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 request)
Returns the current status of Easy DKIM signing for an entity.GetIdentityMailFromDomainAttributesResult
getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest request)
Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).GetIdentityNotificationAttributesResult
getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest request)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.GetIdentityPoliciesResult
getIdentityPolicies(GetIdentityPoliciesRequest request)
Returns the requested sending authorization policies for the given identity (email address or domain).GetIdentityVerificationAttributesResult
getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest request)
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 request)
Returns the user's current sending limits.GetSendStatisticsResult
getSendStatistics()
Simplified method form for invoking the GetSendStatistics operation.GetSendStatisticsResult
getSendStatistics(GetSendStatisticsRequest request)
Returns the user's sending statistics.ListIdentitiesResult
listIdentities()
Simplified method form for invoking the ListIdentities operation.ListIdentitiesResult
listIdentities(ListIdentitiesRequest request)
Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status.ListIdentityPoliciesResult
listIdentityPolicies(ListIdentityPoliciesRequest request)
Returns a list of sending authorization policies that are attached to the given identity (email address or domain).ListReceiptFiltersResult
listReceiptFilters(ListReceiptFiltersRequest request)
Lists the IP address filters associated with your account.ListReceiptRuleSetsResult
listReceiptRuleSets(ListReceiptRuleSetsRequest request)
Lists the receipt rule sets that exist under your AWS account.ListVerifiedEmailAddressesResult
listVerifiedEmailAddresses()
Simplified method form for invoking the ListVerifiedEmailAddresses operation.ListVerifiedEmailAddressesResult
listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest request)
Returns a list containing all of the email addresses that have been verified.PutIdentityPolicyResult
putIdentityPolicy(PutIdentityPolicyRequest request)
Adds or updates a sending authorization policy for the specified identity (email address or domain).ReorderReceiptRuleSetResult
reorderReceiptRuleSet(ReorderReceiptRuleSetRequest request)
Reorders the receipt rules within a receipt rule set.SendBounceResult
sendBounce(SendBounceRequest request)
Generates and sends a bounce message to the sender of an email you received through Amazon SES.SendEmailResult
sendEmail(SendEmailRequest request)
Composes an email message based on input data, and then immediately queues the message for sending.SendRawEmailResult
sendRawEmail(SendRawEmailRequest request)
Sends an email message, with header and content specified by the client.SetActiveReceiptRuleSetResult
setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest request)
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 request)
Enables or disables Easy DKIM signing of email sent from an identity:SetIdentityFeedbackForwardingEnabledResult
setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest request)
Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.SetIdentityMailFromDomainResult
setIdentityMailFromDomain(SetIdentityMailFromDomainRequest request)
Enables or disables the custom MAIL FROM domain setup for a verified identity (email address or domain).SetIdentityNotificationTopicResult
setIdentityNotificationTopic(SetIdentityNotificationTopicRequest request)
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 theSource
.SetReceiptRulePositionResult
setReceiptRulePosition(SetReceiptRulePositionRequest request)
Sets the position of the specified receipt rule in the receipt rule set.void
setRegion(Region region)
An alternative toAmazonSimpleEmailService.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 request)
Updates a receipt rule.VerifyDomainDkimResult
verifyDomainDkim(VerifyDomainDkimRequest request)
Returns a set of DKIM tokens for a domain.VerifyDomainIdentityResult
verifyDomainIdentity(VerifyDomainIdentityRequest request)
Verifies a domain.VerifyEmailAddressResult
verifyEmailAddress(VerifyEmailAddressRequest request)
Verifies an email address.VerifyEmailIdentityResult
verifyEmailIdentity(VerifyEmailIdentityRequest request)
Verifies an email address.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
setEndpoint
in interfaceAmazonSimpleEmailService
- 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
public void setRegion(Region region)
Description copied from interface:AmazonSimpleEmailService
An alternative toAmazonSimpleEmailService.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.
- Specified by:
setRegion
in interfaceAmazonSimpleEmailService
- Parameters:
region
- The region this client will communicate with. SeeRegion.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
public CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
cloneReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the CloneReceiptRuleSet operation returned by the service.
-
createReceiptFilter
public CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
createReceiptFilter
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the CreateReceiptFilter operation returned by the service.
-
createReceiptRule
public CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
createReceiptRule
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the CreateReceiptRule operation returned by the service.
-
createReceiptRuleSet
public CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
createReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the CreateReceiptRuleSet operation returned by the service.
-
deleteIdentity
public DeleteIdentityResult deleteIdentity(DeleteIdentityRequest request)
Description copied from interface:AmazonSimpleEmailService
Deletes the specified identity (email address or domain) from the list of verified identities.
This action is throttled at one request per second.
- Specified by:
deleteIdentity
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DeleteIdentity operation returned by the service.
-
deleteIdentityPolicy
public DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
deleteIdentityPolicy
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DeleteIdentityPolicy operation returned by the service.
-
deleteReceiptFilter
public DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
deleteReceiptFilter
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DeleteReceiptFilter operation returned by the service.
-
deleteReceiptRule
public DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
deleteReceiptRule
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DeleteReceiptRule operation returned by the service.
-
deleteReceiptRuleSet
public DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
deleteReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DeleteReceiptRuleSet operation returned by the service.
-
deleteVerifiedEmailAddress
public DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
deleteVerifiedEmailAddress
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DeleteVerifiedEmailAddress operation returned by the service.
-
describeActiveReceiptRuleSet
public DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
describeActiveReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DescribeActiveReceiptRuleSet operation returned by the service.
-
describeReceiptRule
public DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
describeReceiptRule
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DescribeReceiptRule operation returned by the service.
-
describeReceiptRuleSet
public DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
describeReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the DescribeReceiptRuleSet operation returned by the service.
-
getIdentityDkimAttributes
public GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getIdentityDkimAttributes
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetIdentityDkimAttributes operation returned by the service.
-
getIdentityMailFromDomainAttributes
public GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getIdentityMailFromDomainAttributes
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetIdentityMailFromDomainAttributes operation returned by the service.
-
getIdentityNotificationAttributes
public GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getIdentityNotificationAttributes
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetIdentityNotificationAttributes operation returned by the service.
-
getIdentityPolicies
public GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getIdentityPolicies
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetIdentityPolicies operation returned by the service.
-
getIdentityVerificationAttributes
public GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getIdentityVerificationAttributes
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetIdentityVerificationAttributes operation returned by the service.
-
getSendQuota
public GetSendQuotaResult getSendQuota(GetSendQuotaRequest request)
Description copied from interface:AmazonSimpleEmailService
Returns the user's current sending limits.
This action is throttled at one request per second.
- Specified by:
getSendQuota
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetSendQuota operation returned by the service.
-
getSendQuota
public GetSendQuotaResult getSendQuota()
Description copied from interface:AmazonSimpleEmailService
Simplified method form for invoking the GetSendQuota operation.- Specified by:
getSendQuota
in interfaceAmazonSimpleEmailService
- See Also:
AmazonSimpleEmailService.getSendQuota(GetSendQuotaRequest)
-
getSendStatistics
public GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getSendStatistics
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the GetSendStatistics operation returned by the service.
-
getSendStatistics
public GetSendStatisticsResult getSendStatistics()
Description copied from interface:AmazonSimpleEmailService
Simplified method form for invoking the GetSendStatistics operation.- Specified by:
getSendStatistics
in interfaceAmazonSimpleEmailService
- See Also:
AmazonSimpleEmailService.getSendStatistics(GetSendStatisticsRequest)
-
listIdentities
public ListIdentitiesResult listIdentities(ListIdentitiesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
listIdentities
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the ListIdentities operation returned by the service.
-
listIdentities
public ListIdentitiesResult listIdentities()
Description copied from interface:AmazonSimpleEmailService
Simplified method form for invoking the ListIdentities operation.- Specified by:
listIdentities
in interfaceAmazonSimpleEmailService
- See Also:
AmazonSimpleEmailService.listIdentities(ListIdentitiesRequest)
-
listIdentityPolicies
public ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
listIdentityPolicies
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the ListIdentityPolicies operation returned by the service.
-
listReceiptFilters
public ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
listReceiptFilters
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the ListReceiptFilters operation returned by the service.
-
listReceiptRuleSets
public ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest request)
Description copied from interface:AmazonSimpleEmailService
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 toListReceiptRuleSets
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.
- Specified by:
listReceiptRuleSets
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the ListReceiptRuleSets operation returned by the service.
-
listVerifiedEmailAddresses
public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
listVerifiedEmailAddresses
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the ListVerifiedEmailAddresses operation returned by the service.
-
listVerifiedEmailAddresses
public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
Description copied from interface:AmazonSimpleEmailService
Simplified method form for invoking the ListVerifiedEmailAddresses operation.- Specified by:
listVerifiedEmailAddresses
in interfaceAmazonSimpleEmailService
- See Also:
AmazonSimpleEmailService.listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest)
-
putIdentityPolicy
public PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
putIdentityPolicy
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the PutIdentityPolicy operation returned by the service.
-
reorderReceiptRuleSet
public ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
reorderReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the ReorderReceiptRuleSet operation returned by the service.
-
sendBounce
public SendBounceResult sendBounce(SendBounceRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
sendBounce
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SendBounce operation returned by the service.
-
sendEmail
public SendEmailResult sendEmail(SendEmailRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
sendEmail
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SendEmail operation returned by the service.
-
sendRawEmail
public SendRawEmailResult sendRawEmail(SendRawEmailRequest request)
Description copied from interface:AmazonSimpleEmailService
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 parametersSourceArn
,FromArn
, and/orReturnPathArn
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 theSourceIdentityArn
and do not specify either theFromIdentityArn
orReturnPathIdentityArn
. (The same note applies to the corresponding X-headers.) If you only specify theSourceIdentityArn
, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified inSourceIdentityArn
. For more information about sending authorization, see the Amazon SES Developer Guide.
- Specified by:
sendRawEmail
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SendRawEmail operation returned by the service.
-
setActiveReceiptRuleSet
public SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
setActiveReceiptRuleSet
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SetActiveReceiptRuleSet operation returned by the service.
-
setIdentityDkimEnabled
public SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest request)
Description copied from interface:AmazonSimpleEmailService
Enables or disables Easy DKIM signing of email sent from an identity:
- If Easy DKIM signing is enabled for a domain name identity (e.g.,
example.com
), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g.,user@example.com
). - If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.
For email addresses (e.g.,
user@example.com
), you can only enable Easy DKIM signing if the corresponding domain (e.g.,example.com
) has been set up for Easy DKIM using the AWS Console or theVerifyDomainDkim
action.This action is throttled at one request per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
- Specified by:
setIdentityDkimEnabled
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SetIdentityDkimEnabled operation returned by the service.
- If Easy DKIM signing is enabled for a domain name identity (e.g.,
-
setIdentityFeedbackForwardingEnabled
public SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
setIdentityFeedbackForwardingEnabled
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SetIdentityFeedbackForwardingEnabled operation returned by the service.
-
setIdentityMailFromDomain
public SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
setIdentityMailFromDomain
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SetIdentityMailFromDomain operation returned by the service.
-
setIdentityNotificationTopic
public SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
setIdentityNotificationTopic
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SetIdentityNotificationTopic operation returned by the service.
-
setReceiptRulePosition
public SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
setReceiptRulePosition
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the SetReceiptRulePosition operation returned by the service.
-
updateReceiptRule
public UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
updateReceiptRule
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the UpdateReceiptRule operation returned by the service.
-
verifyDomainDkim
public VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
verifyDomainDkim
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the VerifyDomainDkim operation returned by the service.
-
verifyDomainIdentity
public VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest request)
Description copied from interface:AmazonSimpleEmailService
Verifies a domain.
This action is throttled at one request per second.
- Specified by:
verifyDomainIdentity
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the VerifyDomainIdentity operation returned by the service.
-
verifyEmailAddress
public VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
verifyEmailAddress
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the VerifyEmailAddress operation returned by the service.
-
verifyEmailIdentity
public VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
verifyEmailIdentity
in interfaceAmazonSimpleEmailService
- Returns:
- Result of the VerifyEmailIdentity operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AmazonSimpleEmailService
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.- Specified by:
shutdown
in interfaceAmazonSimpleEmailService
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonSimpleEmailService
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.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonSimpleEmailService
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-