Skip to main content

ISESV2UpdateCustomVerificationEmailTemplateRequest

Interface in AWS.SESV2

Interface for UpdateCustomVerificationEmailTemplate requests.

Ancestors

Properties

TemplateName

property TemplateName: string

The name of the custom verification email template to update.

This identifies the specific custom verification email template that will be updated with new content, subject, and redirection URLs. The template must exist in your Amazon SES account before it can be updated. This field is required and must be at least 1 character in length. The template name must reference an existing custom verification email template.

FailureRedirectionURL

property FailureRedirectionURL: string

The URL that recipients are sent to if their email address verification fails.

When a recipient clicks the verification link but the verification process fails (due to expiration, invalid link, or other issues), they will be redirected to this URL with information about the failure. This field is required and should point to a user-friendly page that explains the verification failure and provides options for recipients to request a new verification email or contact support. The failure page improves user experience by providing clear guidance when verification does not succeed as expected.

FromEmailAddress

property FromEmailAddress: string

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

This address appears in the From header of the verification email and must be a verified identity in your Amazon SES account. Recipients will see this as the sender of the verification email. This field is required and must be properly formatted and verified before the template can be used for sending verification emails. Using a recognizable and trustworthy From address increases the likelihood that recipients will open the verification email and complete the process.

SuccessRedirectionURL

property SuccessRedirectionURL: string

The URL that recipients are sent to if their email address is successfully verified.

When a recipient clicks the verification link and their email address is successfully verified, they will be redirected to this URL to confirm the completion of the verification process. This field is required and should point to a confirmation page that welcomes the newly verified user and provides next steps or account access information. The success page enhances user experience by confirming successful verification and guiding users to appropriate next actions in your application.

TemplateContent

property TemplateContent: string

The HTML content of the custom verification email.

This contains the body of the verification email including the verification link, branding, and instructions for recipients. The content may contain HTML formatting with some limitations for security and compatibility. The total size of the email must be less than 10 MB. The content should include clear instructions for verification and must contain the verification link that Amazon SES will process. This field is required and should be crafted to match your application's branding while clearly explaining the verification process to recipients. Well-designed email content increases verification completion rate and provides a professional user experience during the identity verification process.

TemplateSubject

property TemplateSubject: string

The subject line of the custom verification email.

This appears in the email subject line and should clearly indicate that this is a verification email to encourage recipients to open and complete the verification process. This field is required and should be concise, clear, and professional to maximize email deliverability and recipient engagement with the verification process. A clear subject line helps avoid spam filters and ensures recipients understand the purpose and importance of the email.