Class: AWS.SES
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.SES
- Identifier:
- ses
- API Version:
- 2010-12-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
This documentation contains reference information related to the following:
Sending a Request Using SES
var ses = new AWS.SES();
ses.cloneReceiptRuleSet(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the SES object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var ses = new AWS.SES({apiVersion: '2010-12-01'});
You can also set the API version globally in AWS.config.apiVersions using
the ses service identifier:
AWS.config.apiVersions = {
ses: '2010-12-01',
// other service API versions
};
var ses = new AWS.SES();
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
Constructor Summary collapse
-
new AWS.SES(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
cloneReceiptRuleSet(params = {}, callback) ⇒ AWS.Request
Creates a receipt rule set by cloning an existing one.
-
createConfigurationSet(params = {}, callback) ⇒ AWS.Request
Creates a configuration set.
Configuration sets enable you to publish email sending events.
-
createConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request
Creates a configuration set event destination.
Note: When you create or update an event destination, you must provide one, and only one, destination.- createConfigurationSetTrackingOptions(params = {}, callback) ⇒ AWS.Request
Creates an association between a configuration set and a custom domain for open and click event tracking.
- createCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request
Creates a new custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- createReceiptFilter(params = {}, callback) ⇒ AWS.Request
Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- createReceiptRule(params = {}, callback) ⇒ AWS.Request
Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- createReceiptRuleSet(params = {}, callback) ⇒ AWS.Request
Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- createTemplate(params = {}, callback) ⇒ AWS.Request
Creates an email template.
- deleteConfigurationSet(params = {}, callback) ⇒ AWS.Request
Deletes a configuration set.
- deleteConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request
Deletes a configuration set event destination.
- deleteConfigurationSetTrackingOptions(params = {}, callback) ⇒ AWS.Request
Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES.
- deleteCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request
Deletes an existing custom verification email template.
- deleteIdentity(params = {}, callback) ⇒ AWS.Request
Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
.- deleteIdentityPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
- deleteReceiptFilter(params = {}, callback) ⇒ AWS.Request
Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- deleteReceiptRule(params = {}, callback) ⇒ AWS.Request
Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- deleteReceiptRuleSet(params = {}, callback) ⇒ AWS.Request
Deletes the specified receipt rule set and all of the receipt rules it contains.
Note: The currently active rule set cannot be deleted.- deleteTemplate(params = {}, callback) ⇒ AWS.Request
Deletes an email template.
You can execute this operation no more than once per second.
.- deleteVerifiedEmailAddress(params = {}, callback) ⇒ AWS.Request
Deprecated.
- describeActiveReceiptRuleSet(params = {}, callback) ⇒ AWS.Request
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.
You can execute this operation no more than once per second.
.- describeConfigurationSet(params = {}, callback) ⇒ AWS.Request
Returns the details of the specified configuration set.
- describeReceiptRule(params = {}, callback) ⇒ AWS.Request
Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- describeReceiptRuleSet(params = {}, callback) ⇒ AWS.Request
Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- getAccountSendingEnabled(params = {}, callback) ⇒ AWS.Request
Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
.- getCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request
Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- getIdentityDkimAttributes(params = {}, callback) ⇒ AWS.Request
Returns the current status of Easy DKIM signing for an entity.
- getIdentityMailFromDomainAttributes(params = {}, callback) ⇒ AWS.Request
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
.- getIdentityNotificationAttributes(params = {}, callback) ⇒ AWS.Request
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation 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.
.- getIdentityPolicies(params = {}, callback) ⇒ AWS.Request
Returns the requested sending authorization policies for the given identity (an email address or a domain).
- getIdentityVerificationAttributes(params = {}, callback) ⇒ AWS.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.
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.
- getSendQuota(params = {}, callback) ⇒ AWS.Request
Provides the sending limits for the Amazon SES account.
- getSendStatistics(params = {}, callback) ⇒ AWS.Request
Provides sending statistics for the current Amazon Web Services Region.
- getTemplate(params = {}, callback) ⇒ AWS.Request
Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
You can execute this operation no more than once per second.
.- listConfigurationSets(params = {}, callback) ⇒ AWS.Request
Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region.
- listCustomVerificationEmailTemplates(params = {}, callback) ⇒ AWS.Request
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- listIdentities(params = {}, callback) ⇒ AWS.Request
Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
Note: It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you usedIdentityType=Domainin the the original call and received aNextTokenin the response, you should continue providing theIdentityType=Domainparameter for furtherNextTokencalls; however, if you didn't provide theIdentityTypeparameter in the original call, then continue to not provide it for successive pagination calls.- listIdentityPolicies(params = {}, callback) ⇒ AWS.Request
Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).
- listReceiptFilters(params = {}, callback) ⇒ AWS.Request
Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
.- listReceiptRuleSets(params = {}, callback) ⇒ AWS.Request
Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region.
- listTemplates(params = {}, callback) ⇒ AWS.Request
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
You can execute this operation no more than once per second.
.- listVerifiedEmailAddresses(params = {}, callback) ⇒ AWS.Request
Deprecated.
- putConfigurationSetDeliveryOptions(params = {}, callback) ⇒ AWS.Request
Adds or updates the delivery options for a configuration set.
.
- putIdentityPolicy(params = {}, callback) ⇒ AWS.Request
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
Note: This operation is for the identity owner only.- reorderReceiptRuleSet(params = {}, callback) ⇒ AWS.Request
Reorders the receipt rules within a receipt rule set.
Note: All of the rules in the rule set must be represented in this request.- sendBounce(params = {}, callback) ⇒ AWS.Request
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
- sendBulkTemplatedEmail(params = {}, callback) ⇒ AWS.Request
Composes an email message to multiple destinations.
- sendCustomVerificationEmail(params = {}, callback) ⇒ AWS.Request
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it.
- sendEmail(params = {}, callback) ⇒ AWS.Request
Composes an email message and immediately queues it for sending.
- sendRawEmail(params = {}, callback) ⇒ AWS.Request
Composes an email message and immediately queues it for sending.
- createConfigurationSetTrackingOptions(params = {}, callback) ⇒ AWS.Request