@ThreadSafe public class AmazonSimpleEmailServiceClient extends AmazonWebServiceClient implements 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 | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all Amazon SES exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonSimpleEmailServiceClient()
Constructs a new client to invoke service methods on Amazon SES.
|
AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon SES using the
specified AWS account credentials.
|
AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SES using the
specified AWS account credentials and client configuration options.
|
AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon SES using the
specified AWS account credentials provider.
|
AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SES using the
specified AWS account credentials provider and client configuration
options.
|
AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon SES using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AmazonSimpleEmailServiceClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SES.
|
Modifier and Type | Method and Description |
---|---|
CloneReceiptRuleSetResult |
cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one.
|
CreateReceiptFilterResult |
createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
Creates a new IP address filter.
|
CreateReceiptRuleResult |
createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
Creates a receipt rule.
|
CreateReceiptRuleSetResult |
createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
Creates an empty receipt rule set.
|
DeleteIdentityResult |
deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (email address or domain) from the list of
verified identities.
|
DeleteIdentityPolicyResult |
deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity
(email address or domain).
|
DeleteReceiptFilterResult |
deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
Deletes the specified IP address filter.
|
DeleteReceiptRuleResult |
deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
Deletes the specified receipt rule.
|
DeleteReceiptRuleSetResult |
deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it
contains.
|
void |
deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deletes the specified email address from the list of verified addresses.
|
DescribeActiveReceiptRuleSetResult |
describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
Returns the metadata and receipt rules for the receipt rule set that is
currently active.
|
DescribeReceiptRuleResult |
describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
|
DescribeReceiptRuleSetResult |
describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful,
request, typically used for debugging issues where a service isn't acting
as expected.
|
GetIdentityDkimAttributesResult |
getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity.
|
GetIdentityMailFromDomainAttributesResult |
getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email
addresses and/or domains).
|
GetIdentityNotificationAttributesResult |
getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains),
returns a structure describing identity notification attributes.
|
GetIdentityPoliciesResult |
getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
Returns the requested sending authorization policies for the given
identity (email address or domain).
|
GetIdentityVerificationAttributesResult |
getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest)
Given a list of identities (email addresses and/or domains), returns the
verification status and (for domain identities) the verification token
for each identity.
|
GetSendQuotaResult |
getSendQuota()
Simplified method form for invoking the GetSendQuota operation.
|
GetSendQuotaResult |
getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Returns the user's current sending limits.
|
GetSendStatisticsResult |
getSendStatistics()
Simplified method form for invoking the GetSendStatistics operation.
|
GetSendStatisticsResult |
getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Returns the user's sending statistics.
|
ListIdentitiesResult |
listIdentities()
Simplified method form for invoking the ListIdentities operation.
|
ListIdentitiesResult |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and
domains) for a specific AWS Account, regardless of verification status.
|
ListIdentityPoliciesResult |
listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
Returns a list of sending authorization policies that are attached to the
given identity (email address or domain).
|
ListReceiptFiltersResult |
listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your account.
|
ListReceiptRuleSetsResult |
listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your AWS account.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses()
Simplified method form for invoking the ListVerifiedEmailAddresses
operation.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Returns a list containing all of the email addresses that have been
verified.
|
PutIdentityPolicyResult |
putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity
(email address or domain).
|
ReorderReceiptRuleSetResult |
reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
Reorders the receipt rules within a receipt rule set.
|
SendBounceResult |
sendBounce(SendBounceRequest sendBounceRequest)
Generates and sends a bounce message to the sender of an email you
received through Amazon SES.
|
SendEmailResult |
sendEmail(SendEmailRequest sendEmailRequest)
Composes an email message based on input data, and then immediately
queues the message for sending.
|
SendRawEmailResult |
sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
Sends an email message, with header and content specified by the client.
|
SetActiveReceiptRuleSetResult |
setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
Sets the specified receipt rule set as the active receipt rule set.
|
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.
|
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonSimpleEmailServiceClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonSimpleEmailServiceClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Amazon SES (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon SES (ex: proxy settings, retry counts, etc.).public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon SES (ex: proxy settings, retry counts, etc.).public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon SES (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic 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.
cloneReceiptRuleSet
in interface AmazonSimpleEmailService
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.public 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.
createReceiptFilter
in interface AmazonSimpleEmailService
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.public 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.
createReceiptRule
in interface AmazonSimpleEmailService
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.public 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.
createReceiptRuleSet
in interface AmazonSimpleEmailService
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.public 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.
deleteIdentity
in interface AmazonSimpleEmailService
deleteIdentityRequest
- public 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.
deleteIdentityPolicy
in interface AmazonSimpleEmailService
deleteIdentityPolicyRequest
- public 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.
deleteReceiptFilter
in interface AmazonSimpleEmailService
deleteReceiptFilterRequest
- public 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.
deleteReceiptRule
in interface AmazonSimpleEmailService
deleteReceiptRuleRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.public 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.
deleteReceiptRuleSet
in interface AmazonSimpleEmailService
deleteReceiptRuleSetRequest
- CannotDeleteException
- Indicates that the delete operation could not be completed.public void deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deletes the specified email address from the list of verified addresses.
This action is throttled at one request per second.
deleteVerifiedEmailAddress
in interface AmazonSimpleEmailService
deleteVerifiedEmailAddressRequest
- public 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.
describeActiveReceiptRuleSet
in interface AmazonSimpleEmailService
describeActiveReceiptRuleSetRequest
- public 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.
describeReceiptRule
in interface AmazonSimpleEmailService
describeReceiptRuleRequest
- RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.public 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.
describeReceiptRuleSet
in interface AmazonSimpleEmailService
describeReceiptRuleSetRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.public 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.
getIdentityDkimAttributes
in interface AmazonSimpleEmailService
getIdentityDkimAttributesRequest
- public 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.
getIdentityMailFromDomainAttributes
in interface AmazonSimpleEmailService
getIdentityMailFromDomainAttributesRequest
- public 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.
getIdentityNotificationAttributes
in interface AmazonSimpleEmailService
getIdentityNotificationAttributesRequest
- public 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.
getIdentityPolicies
in interface AmazonSimpleEmailService
getIdentityPoliciesRequest
- public 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.
getIdentityVerificationAttributes
in interface AmazonSimpleEmailService
getIdentityVerificationAttributesRequest
- public GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Returns the user's current sending limits.
This action is throttled at one request per second.
getSendQuota
in interface AmazonSimpleEmailService
getSendQuotaRequest
- public GetSendQuotaResult getSendQuota()
AmazonSimpleEmailService
getSendQuota
in interface AmazonSimpleEmailService
AmazonSimpleEmailService.getSendQuota(GetSendQuotaRequest)
public 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.
getSendStatistics
in interface AmazonSimpleEmailService
getSendStatisticsRequest
- public GetSendStatisticsResult getSendStatistics()
AmazonSimpleEmailService
getSendStatistics
in interface AmazonSimpleEmailService
AmazonSimpleEmailService.getSendStatistics(GetSendStatisticsRequest)
public 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.
listIdentities
in interface AmazonSimpleEmailService
listIdentitiesRequest
- public ListIdentitiesResult listIdentities()
AmazonSimpleEmailService
listIdentities
in interface AmazonSimpleEmailService
AmazonSimpleEmailService.listIdentities(ListIdentitiesRequest)
public 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.
listIdentityPolicies
in interface AmazonSimpleEmailService
listIdentityPoliciesRequest
- public 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.
listReceiptFilters
in interface AmazonSimpleEmailService
listReceiptFiltersRequest
- public 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.
listReceiptRuleSets
in interface AmazonSimpleEmailService
listReceiptRuleSetsRequest
- public 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.
listVerifiedEmailAddresses
in interface AmazonSimpleEmailService
listVerifiedEmailAddressesRequest
- public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
AmazonSimpleEmailService
listVerifiedEmailAddresses
in interface AmazonSimpleEmailService
AmazonSimpleEmailService.listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest)
public 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.
putIdentityPolicy
in interface AmazonSimpleEmailService
putIdentityPolicyRequest
- InvalidPolicyException
- Indicates that the provided policy is invalid. Check the error
stack for more information about what caused the error.public 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.
reorderReceiptRuleSet
in interface AmazonSimpleEmailService
reorderReceiptRuleSetRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.public 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.
sendBounce
in interface AmazonSimpleEmailService
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.public 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
:
sendEmail
in interface AmazonSimpleEmailService
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.public 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.sendRawEmail
in interface AmazonSimpleEmailService
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.public 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.
setActiveReceiptRuleSet
in interface AmazonSimpleEmailService
setActiveReceiptRuleSetRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.public 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.
setIdentityDkimEnabled
in interface AmazonSimpleEmailService
setIdentityDkimEnabledRequest
- public 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.
setIdentityFeedbackForwardingEnabled
in interface AmazonSimpleEmailService
setIdentityFeedbackForwardingEnabledRequest
- public 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.
setIdentityMailFromDomain
in interface AmazonSimpleEmailService
setIdentityMailFromDomainRequest
- public 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.
setIdentityNotificationTopic
in interface AmazonSimpleEmailService
setIdentityNotificationTopicRequest
- public 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.
setReceiptRulePosition
in interface AmazonSimpleEmailService
setReceiptRulePositionRequest
- RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.public 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.
updateReceiptRule
in interface AmazonSimpleEmailService
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.public 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.
verifyDomainDkim
in interface AmazonSimpleEmailService
verifyDomainDkimRequest
- public VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Verifies a domain.
This action is throttled at one request per second.
verifyDomainIdentity
in interface AmazonSimpleEmailService
verifyDomainIdentityRequest
- public void 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.
verifyEmailAddress
in interface AmazonSimpleEmailService
verifyEmailAddressRequest
- public 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.
verifyEmailIdentity
in interface AmazonSimpleEmailService
verifyEmailIdentityRequest
- public 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 the request.
getCachedResponseMetadata
in interface AmazonSimpleEmailService
request
- The originally executed requestCopyright © 2016. All rights reserved.