interface EmailSettings
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Cognito.EmailSettings |
 Java | software.amazon.awscdk.services.cognito.EmailSettings |
 Python | aws_cdk.aws_cognito.EmailSettings |
 TypeScript (source) | @aws-cdk/aws-cognito » EmailSettings |
Email settings for the user pool.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
const emailSettings: cognito.EmailSettings = {
from: 'from',
replyTo: 'replyTo',
};
Properties
| Name | Type | Description |
|---|---|---|
| from? | string | The 'from' address on the emails received by the user. |
| reply | string | The 'replyTo' address on the emails received by the user as defined by IETF RFC-5322. |
from?
Type:
string
(optional, default: noreply)
The 'from' address on the emails received by the user.
replyTo?
Type:
string
(optional, default: Not set.)
The 'replyTo' address on the emails received by the user as defined by IETF RFC-5322.
When set, most email clients recognize to change 'to' line to this address when a reply is drafted.