# UserPoolEmailConfig

Result of binding email settings with a user pool.

- Source: [`aws-cognito/lib/user-pool-email.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool-email.ts#L71)
- Type last changed: v2.164.0 · 24 Oct 2024

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const userPoolEmailConfig: cognito.UserPoolEmailConfig = {
  configurationSet: 'configurationSet',
  emailSendingAccount: 'emailSendingAccount',
  from: 'from',
  replyToEmailAddress: 'replyToEmailAddress',
  sourceArn: 'sourceArn',
};
```

## Properties

- `configurationSet`: string = none — The name of the configuration set in SES.

- `emailSendingAccount`: string — Specifies whether to use Cognito's built in email functionality or SES.

  **Default:** Cognito built in email functionality

- `from`: string = 'no-reply@verificationemail.com' — Identifies either the sender's email address or the sender's name with their email address.

  If emailSendingAccount is DEVELOPER then this cannot be specified.

- `replyToEmailAddress`: string — The destination to which the receiver of the email should reply to.

  **Default:** same as `from`

- `sourceArn`: string = none — The ARN of a verified email address in Amazon SES.

  required if emailSendingAccount is DEVELOPER or if
  'from' is provided.