/AWS1/CL_CGPVERIFICATIONMSGT00¶
The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_smsmessage TYPE /AWS1/CGPSMSVERIFICATIONMSGT00 /AWS1/CGPSMSVERIFICATIONMSGT00¶
The template for SMS messages that Amazon Cognito sends to your users.
iv_emailmessage TYPE /AWS1/CGPEMAILVERIFICATIONMS00 /AWS1/CGPEMAILVERIFICATIONMS00¶
The template for email messages that Amazon Cognito sends to your users. You can set an
EmailMessagetemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
iv_emailsubject TYPE /AWS1/CGPEMAILVERIFICATIONSU00 /AWS1/CGPEMAILVERIFICATIONSU00¶
The subject line for the email message template. You can set an
EmailSubjecttemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
iv_emailmessagebylink TYPE /AWS1/CGPEMAILVERIFICATIONMS01 /AWS1/CGPEMAILVERIFICATIONMS01¶
The email message template for sending a confirmation link to the user. You can set an
EmailMessageByLinktemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
iv_emailsubjectbylink TYPE /AWS1/CGPEMAILVERIFICATIONSU01 /AWS1/CGPEMAILVERIFICATIONSU01¶
The subject line for the email message template for sending a confirmation link to the user. You can set an
EmailSubjectByLinktemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
iv_defaultemailoption TYPE /AWS1/CGPDEFEMAILOPTIONTYPE /AWS1/CGPDEFEMAILOPTIONTYPE¶
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{####}.
Queryable Attributes¶
SmsMessage¶
The template for SMS messages that Amazon Cognito sends to your users.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SMSMESSAGE() |
Getter for SMSMESSAGE, with configurable default |
ASK_SMSMESSAGE() |
Getter for SMSMESSAGE w/ exceptions if field has no value |
HAS_SMSMESSAGE() |
Determine if SMSMESSAGE has a value |
EmailMessage¶
The template for email messages that Amazon Cognito sends to your users. You can set an
EmailMessagetemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EMAILMESSAGE() |
Getter for EMAILMESSAGE, with configurable default |
ASK_EMAILMESSAGE() |
Getter for EMAILMESSAGE w/ exceptions if field has no value |
HAS_EMAILMESSAGE() |
Determine if EMAILMESSAGE has a value |
EmailSubject¶
The subject line for the email message template. You can set an
EmailSubjecttemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EMAILSUBJECT() |
Getter for EMAILSUBJECT, with configurable default |
ASK_EMAILSUBJECT() |
Getter for EMAILSUBJECT w/ exceptions if field has no value |
HAS_EMAILSUBJECT() |
Determine if EMAILSUBJECT has a value |
EmailMessageByLink¶
The email message template for sending a confirmation link to the user. You can set an
EmailMessageByLinktemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EMAILMESSAGEBYLINK() |
Getter for EMAILMESSAGEBYLINK, with configurable default |
ASK_EMAILMESSAGEBYLINK() |
Getter for EMAILMESSAGEBYLINK w/ exceptions if field has no |
HAS_EMAILMESSAGEBYLINK() |
Determine if EMAILMESSAGEBYLINK has a value |
EmailSubjectByLink¶
The subject line for the email message template for sending a confirmation link to the user. You can set an
EmailSubjectByLinktemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EMAILSUBJECTBYLINK() |
Getter for EMAILSUBJECTBYLINK, with configurable default |
ASK_EMAILSUBJECTBYLINK() |
Getter for EMAILSUBJECTBYLINK w/ exceptions if field has no |
HAS_EMAILSUBJECTBYLINK() |
Determine if EMAILSUBJECTBYLINK has a value |
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{####}.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTEMAILOPTION() |
Getter for DEFAULTEMAILOPTION, with configurable default |
ASK_DEFAULTEMAILOPTION() |
Getter for DEFAULTEMAILOPTION w/ exceptions if field has no |
HAS_DEFAULTEMAILOPTION() |
Determine if DEFAULTEMAILOPTION has a value |