Interface IEmailIdentityProps
Properties for an email identity.
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEmailIdentityProps
Syntax (vb)
Public Interface 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
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. |
Properties
ConfigurationSet
The configuration set to associate with the email identity.
virtual IConfigurationSet ConfigurationSet { get; }
Property Value
Remarks
Default: - do not use a specific configuration set
DkimIdentity
The type of DKIM identity to use.
virtual DkimIdentity DkimIdentity { get; }
Property Value
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.
virtual Nullable<bool> DkimSigning { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
FeedbackForwarding
Whether to receive email notifications when bounce or complaint events occur.
virtual Nullable<bool> FeedbackForwarding { get; }
Property Value
System.Nullable<System.Boolean>
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
MailFromBehaviorOnMxFailure
The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.
virtual Nullable<MailFromBehaviorOnMxFailure> MailFromBehaviorOnMxFailure { get; }
Property Value
System.Nullable<MailFromBehaviorOnMxFailure>
Remarks
Default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE
MailFromDomain
The custom MAIL FROM domain that you want the verified identity to use.
virtual string MailFromDomain { get; }
Property Value
System.String
Remarks
The MAIL FROM domain must meet the following criteria:
Default: - use amazonses.com