Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SES

Amazon Simple Email Service

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.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly config

The resolved configuration of SESClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

cloneReceiptRuleSet

createConfigurationSet

createConfigurationSetEventDestination

createConfigurationSetTrackingOptions

createCustomVerificationEmailTemplate

createReceiptFilter

createReceiptRule

createReceiptRuleSet

createTemplate

deleteConfigurationSet

deleteConfigurationSetEventDestination

deleteConfigurationSetTrackingOptions

  • 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. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    Parameters

    Returns Promise<DeleteConfigurationSetTrackingOptionsCommandOutput>

  • 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. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    Parameters

    Returns void

  • 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. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    Parameters

    Returns void

  • 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. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    Parameters

    • args: DeleteConfigurationSetTrackingOptionsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteConfigurationSetTrackingOptionsCommandOutput>

  • 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. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    Parameters

    Returns void

  • 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. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    Parameters

    Returns void

deleteCustomVerificationEmailTemplate

deleteIdentity

deleteIdentityPolicy

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<DeleteIdentityPolicyCommandOutput>

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    • args: DeleteIdentityPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteIdentityPolicyCommandOutput>

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

deleteReceiptFilter

deleteReceiptRule

deleteReceiptRuleSet

deleteTemplate

deleteVerifiedEmailAddress

describeActiveReceiptRuleSet

describeConfigurationSet

describeReceiptRule

describeReceiptRuleSet

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getAccountSendingEnabled

getCustomVerificationEmailTemplate

getIdentityDkimAttributes

  • Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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 operation 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 operation 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.

    Parameters

    Returns Promise<GetIdentityDkimAttributesCommandOutput>

  • Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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 operation 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 operation 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.

    Parameters

    Returns void

  • Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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 operation 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 operation 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.

    Parameters

    Returns void

  • Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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 operation 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 operation 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.

    Parameters

    • args: GetIdentityDkimAttributesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetIdentityDkimAttributesCommandOutput>

  • Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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 operation 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 operation 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.

    Parameters

    Returns void

  • Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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 operation 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 operation 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.

    Parameters

    Returns void

getIdentityMailFromDomainAttributes

getIdentityNotificationAttributes

getIdentityPolicies

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<GetIdentityPoliciesCommandOutput>

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    • args: GetIdentityPoliciesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetIdentityPoliciesCommandOutput>

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

getIdentityVerificationAttributes

  • 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 operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    Parameters

    Returns Promise<GetIdentityVerificationAttributesCommandOutput>

  • 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 operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    Parameters

    Returns void

  • 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 operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    Parameters

    Returns void

  • 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 operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    Parameters

    • args: GetIdentityVerificationAttributesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetIdentityVerificationAttributesCommandOutput>

  • 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 operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    Parameters

    Returns void

  • 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 operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    Parameters

    Returns void

getSendQuota

getSendStatistics

  • Provides sending statistics for the current AWS Region. 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 period of time.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<GetSendStatisticsCommandOutput>

  • Provides sending statistics for the current AWS Region. 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 period of time.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Provides sending statistics for the current AWS Region. 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 period of time.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Provides sending statistics for the current AWS Region. 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 period of time.

    You can execute this operation no more than once per second.

    Parameters

    • args: GetSendStatisticsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetSendStatisticsCommandOutput>

  • Provides sending statistics for the current AWS Region. 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 period of time.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Provides sending statistics for the current AWS Region. 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 period of time.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

getTemplate

  • 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.

    Parameters

    Returns Promise<GetTemplateCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: GetTemplateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetTemplateCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

listConfigurationSets

  • Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    Parameters

    Returns Promise<ListConfigurationSetsCommandOutput>

  • Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    Parameters

    Returns void

  • Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    Parameters

    Returns void

  • Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    Parameters

    • args: ListConfigurationSetsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListConfigurationSetsCommandOutput>

  • Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    Parameters

    Returns void

  • Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    Parameters

    Returns void

listCustomVerificationEmailTemplates

listIdentities

  • Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<ListIdentitiesCommandOutput>

  • Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    Parameters

    • args: ListIdentitiesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListIdentitiesCommandOutput>

  • Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

listIdentityPolicies

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<ListIdentityPoliciesCommandOutput>

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    • args: ListIdentityPoliciesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListIdentityPoliciesCommandOutput>

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

listReceiptFilters

listReceiptRuleSets

  • Lists the receipt rule sets that exist under your AWS account in the current AWS Region. 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<ListReceiptRuleSetsCommandOutput>

  • Lists the receipt rule sets that exist under your AWS account in the current AWS Region. 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Lists the receipt rule sets that exist under your AWS account in the current AWS Region. 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Lists the receipt rule sets that exist under your AWS account in the current AWS Region. 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.

    You can execute this operation no more than once per second.

    Parameters

    • args: ListReceiptRuleSetsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListReceiptRuleSetsCommandOutput>

  • Lists the receipt rule sets that exist under your AWS account in the current AWS Region. 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Lists the receipt rule sets that exist under your AWS account in the current AWS Region. 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

listTemplates

listVerifiedEmailAddresses

putConfigurationSetDeliveryOptions

putIdentityPolicy

  • Adds or updates a sending authorization policy for the specified identity (an email address or a 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<PutIdentityPolicyCommandOutput>

  • Adds or updates a sending authorization policy for the specified identity (an email address or a 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Adds or updates a sending authorization policy for the specified identity (an email address or a 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Adds or updates a sending authorization policy for the specified identity (an email address or a 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.

    You can execute this operation no more than once per second.

    Parameters

    • args: PutIdentityPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutIdentityPolicyCommandOutput>

  • Adds or updates a sending authorization policy for the specified identity (an email address or a 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • Adds or updates a sending authorization policy for the specified identity (an email address or a 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

reorderReceiptRuleSet

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<ReorderReceiptRuleSetCommandOutput>

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    • args: ReorderReceiptRuleSetCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ReorderReceiptRuleSetCommandOutput>

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

send

sendBounce

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns Promise<SendBounceCommandOutput>

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    • args: SendBounceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<SendBounceCommandOutput>

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

  • 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.

    You can execute this operation no more than once per second.

    Parameters

    Returns void

sendBulkTemplatedEmail

  • Composes an email message to multiple destinations. The message body is created using an email template.

    In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. 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 the SendBulkTemplatedEmail operation several times to send the message to each group.

    • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

    Parameters

    Returns Promise<SendBulkTemplatedEmailCommandOutput>

  • Composes an email message to multiple destinations. The message body is created using an email template.

    In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. 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 the SendBulkTemplatedEmail operation several times to send the message to each group.

    • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

    Parameters

    Returns void

  • Composes an email message to multiple destinations. The message body is created using an email template.

    In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. 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 the SendBulkTemplatedEmail operation several times to send the message to each group.

    • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

    Parameters

    Returns void

  • Composes an email message to multiple destinations. The message body is created using an email template.

    In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. 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 the SendBulkTemplatedEmail operation several times to send the message to each group.

    • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

    Parameters

    • args: SendBulkTemplatedEmailCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<SendBulkTemplatedEmailCommandOutput>

  • Composes an email message to multiple destinations. The message body is created using an email template.

    In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. 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 the SendBulkTemplatedEmail operation several times to send the message to each group.

    • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

    Parameters