Amazon Simple Email Service

2017/12/07 - Amazon Simple Email Service - 6 new api methods

Changes  Update ses client to latest version

SendCustomVerificationEmail (new) Link ¶

Sends a custom verification email to a specified recipient. Verification emails sent using this operation are counted against your 24-hour sending quota and per-second sending rate.

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

client.send_custom_verification_email(
    EmailAddress='string',
    TemplateName='string',
    ConfigurationSetName='string'
)
type EmailAddress:

string

param EmailAddress:

[REQUIRED]

The email address to verify.

type TemplateName:

string

param TemplateName:

[REQUIRED]

The name of the custom verification email template to use when sending the verification email.

type ConfigurationSetName:

string

param ConfigurationSetName:

Name of a configuration set to use when sending the verification email.

rtype:

dict

returns:

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    The response received when attempting to send the custom verification email.

    • MessageId (string) --

      The unique message identifier returned from the SendCustomVerificationEmail operation.

GetCustomVerificationEmailTemplate (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.get_custom_verification_email_template(
    TemplateName='string'
)
type TemplateName:

string

param TemplateName:

[REQUIRED]

The name of the custom verification email template that you want to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'TemplateName': 'string',
    'FromEmailAddress': 'string',
    'TemplateSubject': 'string',
    'TemplateContent': 'string',
    'SuccessRedirectionURL': 'string',
    'FailureRedirectionURL': 'string'
}

Response Structure

  • (dict) --

    The content of the custom verification email template.

    • TemplateName (string) --

      The name of the custom verification email template.

    • FromEmailAddress (string) --

      The email address that the custom verification email is sent from.

    • TemplateSubject (string) --

      The subject line of the custom verification email.

    • TemplateContent (string) --

      The content of the custom verification email.

    • SuccessRedirectionURL (string) --

      The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    • FailureRedirectionURL (string) --

      The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

CreateCustomVerificationEmailTemplate (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.create_custom_verification_email_template(
    TemplateName='string',
    FromEmailAddress='string',
    TemplateSubject='string',
    TemplateContent='string',
    SuccessRedirectionURL='string',
    FailureRedirectionURL='string'
)
type TemplateName:

string

param TemplateName:

[REQUIRED]

The name of the custom verification email template.

type FromEmailAddress:

string

param FromEmailAddress:

[REQUIRED]

The email address that the custom verification email is sent from.

type TemplateSubject:

string

param TemplateSubject:

[REQUIRED]

The subject line of the custom verification email.

type TemplateContent:

string

param TemplateContent:

[REQUIRED]

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

type SuccessRedirectionURL:

string

param SuccessRedirectionURL:

[REQUIRED]

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

type FailureRedirectionURL:

string

param FailureRedirectionURL:

[REQUIRED]

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

returns:

None

ListCustomVerificationEmailTemplates (new) Link ¶

Lists the existing custom verification email templates for your account.

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.

See also: AWS API Documentation

Request Syntax

client.list_custom_verification_email_templates(
    NextToken='string',
    MaxResults=123
)
type NextToken:

string

param NextToken:

A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of email templates.

type MaxResults:

integer

param MaxResults:

The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.

rtype:

dict

returns:

Response Syntax

{
    'CustomVerificationEmailTemplates': [
        {
            'TemplateName': 'string',
            'FromEmailAddress': 'string',
            'TemplateSubject': 'string',
            'SuccessRedirectionURL': 'string',
            'FailureRedirectionURL': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    A paginated list of custom verification email templates.

    • CustomVerificationEmailTemplates (list) --

      A list of the custom verification email templates that exist in your account.

      • (dict) --

        Contains information about a custom verification email template.

        • TemplateName (string) --

          The name of the custom verification email template.

        • FromEmailAddress (string) --

          The email address that the custom verification email is sent from.

        • TemplateSubject (string) --

          The subject line of the custom verification email.

        • SuccessRedirectionURL (string) --

          The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

        • FailureRedirectionURL (string) --

          The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    • NextToken (string) --

      A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification email templates.

DeleteCustomVerificationEmailTemplate (new) Link ¶

Deletes an existing 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.

See also: AWS API Documentation

Request Syntax

client.delete_custom_verification_email_template(
    TemplateName='string'
)
type TemplateName:

string

param TemplateName:

[REQUIRED]

The name of the custom verification email template that you want to delete.

returns:

None

UpdateCustomVerificationEmailTemplate (new) Link ¶

Updates an existing 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.

See also: AWS API Documentation

Request Syntax

client.update_custom_verification_email_template(
    TemplateName='string',
    FromEmailAddress='string',
    TemplateSubject='string',
    TemplateContent='string',
    SuccessRedirectionURL='string',
    FailureRedirectionURL='string'
)
type TemplateName:

string

param TemplateName:

[REQUIRED]

The name of the custom verification email template that you want to update.

type FromEmailAddress:

string

param FromEmailAddress:

The email address that the custom verification email is sent from.

type TemplateSubject:

string

param TemplateSubject:

The subject line of the custom verification email.

type TemplateContent:

string

param TemplateContent:

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

type SuccessRedirectionURL:

string

param SuccessRedirectionURL:

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

type FailureRedirectionURL:

string

param FailureRedirectionURL:

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

returns:

None