baiji v0.6.11 Baiji.SES
Amazon Simple Email Service
This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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
Creates a configuration set
Creates a configuration set event destination
Creates a new IP address filter
Creates a receipt rule
Creates an empty receipt rule set
Deletes a configuration set
Deletes a configuration set event destination
Deletes the specified identity (an email address or a domain) from the list of verified identities
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist
Deletes the specified IP address filter
Deletes the specified receipt rule
Deletes the specified receipt rule set and all of the receipt rules it contains
Deletes the specified email address from the list of verified addresses
Returns the metadata and receipt rules for the receipt rule set that is currently active
Returns the details of the specified configuration set
Returns the details of the specified receipt rule
Returns the details of the specified receipt rule set
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
Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes
Returns the requested sending authorization policies for the given identity (an email address or a 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
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity
Returns the user’s current sending limits
Returns the user’s sending statistics. The result is a list of data points, representing the last two weeks of sending activity
Lists the configuration sets associated with your AWS account
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status
Returns a list of sending authorization policies that are attached to the
given identity (an email address or a domain). This API returns only a
list. If you want the actual policy content, you can use
GetIdentityPolicies
Lists the IP address filters associated with your AWS account
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
Returns a list containing all of the email addresses that have been verified
Adds or updates a sending authorization policy for the specified identity (an email address or a domain)
Reorders the receipt rules within a receipt rule set
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
Composes an email message based on input data, and then immediately queues the message for sending
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
Sets the specified receipt rule set as the active receipt rule set
Enables or disables Easy DKIM signing of email sent from an identity
Given an identity (an email address or a 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
Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain)
Given an identity (an email address or a 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
Sets the position of the specified receipt rule in the receipt rule set
Updates the event destination of a configuration set
Updates a receipt rule
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
Verifies a domain
Verifies an email address. This action causes a confirmation email message to be sent to the specified address
Verifies an email address. This action causes a confirmation email message to be sent to the specified address
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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.
Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
Creates a configuration set event destination.
publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.
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.
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.
Deletes a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
Deletes a configuration set event destination.
Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
Deletes the specified identity (an email address or a domain) from the list of verified identities.
This action is throttled at one request per second.
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
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.
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.
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.
Deletes the specified receipt rule set and all of the receipt rules it contains.
SES Developer Guide](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html).
This action is throttled at one request per second.
Deletes the specified email address from the list of verified addresses.
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.
Returns the details of the specified configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.
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.
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.
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.
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.
Returns the requested sending authorization policies for the given identity (an email address or a 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.
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.
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is “Pending” until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to “Success”. If the link is not clicked within 24 hours, the verification status changes to “Failed.” In that case, if you still want to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain’s verification status is “Pending” as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain’s verification status changes to “Success”. If Amazon SES is unable to detect the record within 72 hours, the domain’s verification status changes to “Failed.” In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
Returns the user’s current sending limits.
This action is throttled at one request per second.
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.
Lists the configuration sets associated with your AWS account.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second and can return up to 50 configuration sets at a time.
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
This action is throttled at one request per second.
Returns a list of sending authorization policies that are attached to the
given identity (an email address or a domain). This API returns only a
list. If you want the actual policy content, you can use
GetIdentityPolicies
.
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.
Lists the IP address filters associated with your AWS account.
For information about managing IP address filters, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.
Returns a list containing all of the email addresses that have been verified.
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
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.
Reorders the receipt rules within a receipt rule set.
SES Developer Guide](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html).
This action is throttled at one request per second.
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.
This action is throttled at one request per second.
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](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html).
- The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
- You must provide at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If any email address you provide is invalid, Amazon SES rejects the entire email.
- 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](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html).
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](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html).
- The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
- You must provide at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If any email address you provide is invalid, Amazon SES rejects the entire email.
- 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.
- Amazon SES overrides any Message-ID and Date headers you provide.
- 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](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html).
- If you are using sending authorization to send on behalf of
another user, `SendRawEmail` enables you to specify the cross-account
identity for the email's "Source," "From," and "Return-Path" parameters in
one of two ways: you can pass optional parameters `SourceArn`, `FromArn`,
and/or `ReturnPathArn` to the API, or you can include the following
X-headers in the header of your raw email:
- `X-SES-SOURCE-ARN`
- `X-SES-FROM-ARN`
- `X-SES-RETURN-PATH-ARN`
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For the most common sending authorization use case, we recommend that you specify the `SourceIdentityArn` and do not specify either the `FromIdentityArn` or `ReturnPathIdentityArn`. (The same note applies to the corresponding X-headers.) If you only specify the `SourceIdentityArn`, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in `SourceIdentityArn`. For more information about sending authorization, see the [Amazon SES Developer Guide](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
Sets the specified receipt rule set as the active receipt rule set.
SES Developer Guide](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html).
This action is throttled at one request per second.
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.
Given an identity (an email address or a 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.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
This action is throttled at one request per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
Given an identity (an email address or a 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
.
For more information about feedback notification, see the Amazon SES Developer Guide.
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.
Updates the event destination of a configuration set.
enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.
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.
Verifies a domain.
This action is throttled at one request per second.
Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
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.