AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.VerificationMessageTemplateType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class VerificationMessageTemplateType

The VerificationMessageTemplateType type exposes the following members

Constructors

NameDescription
Public Method VerificationMessageTemplateType()

Properties

NameTypeDescription
Public Property DefaultEmailOption Amazon.CognitoIdentityProvider.DefaultEmailOptionType

Gets and sets the property DefaultEmailOption.

The configuration of verification emails to contain a clickable link or a verification code.

For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.

Public Property EmailMessage System.String

Gets and sets the property EmailMessage.

The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Public Property EmailMessageByLink System.String

Gets and sets the property EmailMessageByLink.

The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Public Property EmailSubject System.String

Gets and sets the property EmailSubject.

The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Public Property EmailSubjectByLink System.String

Gets and sets the property EmailSubjectByLink.

The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Public Property SmsMessage System.String

Gets and sets the property SmsMessage.

The template for SMS messages that Amazon Cognito sends to your users.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5