EmailIdentityProps

class aws_cdk.aws_ses.EmailIdentityProps(*, identity, configuration_set=None, dkim_identity=None, dkim_signing=None, feedback_forwarding=None, mail_from_behavior_on_mx_failure=None, mail_from_domain=None)

Bases: object

Properties for an email identity.

Parameters:

identity (Identity) – The email address or domain to verify.
configuration_set (Optional[IConfigurationSet]) – The configuration set to associate with the email identity. Default: - do not use a specific configuration set
dkim_identity (Optional[DkimIdentity]) – The type of DKIM identity to use. Default: - Easy DKIM with a key length of 2048-bit
dkim_signing (Optional[bool]) – Whether the messages that are sent from the identity are signed using DKIM. Default: true
feedback_forwarding (Optional[bool]) – Whether to receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled). Default: true
mail_from_behavior_on_mx_failure (Optional[MailFromBehaviorOnMxFailure]) – The action to take if the required MX record for the MAIL FROM domain isn’t found when you send an email. Default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE
mail_from_domain (Optional[str]) – The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria: - It has to be a subdomain of the verified identity - It can’t be used to receive email - It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails Default: - use amazonses.com

ExampleMetadata:

infused

Example:

import aws_cdk.aws_iam as iam
# user: iam.User


identity = ses.EmailIdentity(self, "Identity",
    identity=ses.Identity.domain("cdk.dev")
)

identity.grant_send_email(user)

Attributes

configuration_set

The configuration set to associate with the email identity.

Default:

do not use a specific configuration set

dkim_identity

The type of DKIM identity to use.

Default:

Easy DKIM with a key length of 2048-bit

dkim_signing

Whether the messages that are sent from the identity are signed using DKIM.

Default:: true

feedback_forwarding

Whether to receive email notifications when bounce or complaint events occur.

These notifications are sent to the address that you specified in the Return-Path header of the original email.

You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Default:: true

identity: The email address or domain to verify.

mail_from_behavior_on_mx_failure

The action to take if the required MX record for the MAIL FROM domain isn’t found when you send an email.

Default:: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE

mail_from_domain

The custom MAIL FROM domain that you want the verified identity to use.

The MAIL FROM domain must meet the following criteria:

It has to be a subdomain of the verified identity
It can’t be used to receive email
It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails

Default:

use amazonses.com