Class EmailIdentityProps

Properties for an email identity.

Inheritance

object

EmailIdentityProps

Implements

IEmailIdentityProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EmailIdentityProps : IEmailIdentityProps

Syntax (vb)

Public Class EmailIdentityProps Implements IEmailIdentityProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.IAM;
            User user;


            var identity = new EmailIdentity(this, "Identity", new EmailIdentityProps {
                Identity = Identity.Domain("cdk.dev")
            });

            identity.GrantSendEmail(user);

Synopsis

Constructors

EmailIdentityProps()

Properties for an email identity.

Properties

ConfigurationSet	The configuration set to associate with the email identity.
DkimIdentity	The type of DKIM identity to use.
DkimSigning	Whether the messages that are sent from the identity are signed using DKIM.
FeedbackForwarding	Whether to receive email notifications when bounce or complaint events occur.
Identity	The email address or domain to verify.
MailFromBehaviorOnMxFailure	The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.
MailFromDomain	The custom MAIL FROM domain that you want the verified identity to use.

Constructors

EmailIdentityProps()

Properties for an email identity.

public EmailIdentityProps()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.IAM;
            User user;


            var identity = new EmailIdentity(this, "Identity", new EmailIdentityProps {
                Identity = Identity.Domain("cdk.dev")
            });

            identity.GrantSendEmail(user);

Properties

ConfigurationSet

The configuration set to associate with the email identity.

public IConfigurationSet? ConfigurationSet { get; set; }

Property Value

IConfigurationSet

Remarks

Default: - do not use a specific configuration set

DkimIdentity

The type of DKIM identity to use.

public DkimIdentity? DkimIdentity { get; set; }

Property Value

DkimIdentity

Remarks

Default: - Easy DKIM with a key length of 2048-bit

DkimSigning

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

public bool? DkimSigning { get; set; }

Property Value

bool?

Remarks

Default: true

FeedbackForwarding

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

public bool? FeedbackForwarding { get; set; }

Property Value

bool?

Remarks

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.

public Identity Identity { get; set; }

Property Value

Identity

Remarks

ExampleMetadata: infused

MailFromBehaviorOnMxFailure

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

public MailFromBehaviorOnMxFailure? MailFromBehaviorOnMxFailure { get; set; }

Property Value

MailFromBehaviorOnMxFailure?

Remarks

Default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE

MailFromDomain

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

public string? MailFromDomain { get; set; }

Property Value

string

Remarks

The MAIL FROM domain must meet the following criteria:

Default: - use amazonses.com

Implements

IEmailIdentityProps