SES / Client / send_custom_verification_email

send_custom_verification_email#

SES.Client.send_custom_verification_email(**kwargs)#

Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using 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

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

  • EmailAddress (string) –

    [REQUIRED]

    The email address to verify.

  • TemplateName (string) –

    [REQUIRED]

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

  • ConfigurationSetName (string) – Name of a configuration set to use when sending the verification email.

Return type:

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.

Exceptions

  • SES.Client.exceptions.MessageRejected

  • SES.Client.exceptions.ConfigurationSetDoesNotExistException

  • SES.Client.exceptions.CustomVerificationEmailTemplateDoesNotExistException

  • SES.Client.exceptions.FromEmailAddressNotVerifiedException

  • SES.Client.exceptions.ProductionAccessNotGrantedException