software.amazon.awscdk.services.ses

Interface EmailIdentityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmailIdentityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.200Z")
 @Stability(value=Stable)
public interface EmailIdentityProps
extends software.amazon.jsii.JsiiSerializable

Properties for an email identity.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 IPublicHostedZone myHostedZone;
 EmailIdentity identity = EmailIdentity.Builder.create(stack, "Identity")
         .identity(Identity.publicHostedZone(myHostedZone))
         .mailFromDomain("mail.cdk.dev")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EmailIdentityProps.Builder A builder for EmailIdentityProps
static class	EmailIdentityProps.Jsii$Proxy An implementation for EmailIdentityProps

Method Summary

Modifier and Type	Method and Description
static EmailIdentityProps.Builder	builder()
default IConfigurationSet	getConfigurationSet() The configuration set to associate with the email identity.
default DkimIdentity	getDkimIdentity() The type of DKIM identity to use.
default Boolean	getDkimSigning() Whether the messages that are sent from the identity are signed using DKIM.
default Boolean	getFeedbackForwarding() Whether to receive email notifications when bounce or complaint events occur.
Identity	getIdentity() The email address or domain to verify.
default MailFromBehaviorOnMxFailure	getMailFromBehaviorOnMxFailure() The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.
default String	getMailFromDomain() The custom MAIL FROM domain that you want the verified identity to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIdentity

@Stability(value=Stable)
 @NotNull
Identity getIdentity()

The email address or domain to verify.

getConfigurationSet

@Stability(value=Stable)
 @Nullable
default IConfigurationSet getConfigurationSet()

The configuration set to associate with the email identity.

Default: - do not use a specific configuration set

getDkimIdentity

@Stability(value=Stable)
 @Nullable
default DkimIdentity getDkimIdentity()

The type of DKIM identity to use.

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

getDkimSigning

@Stability(value=Stable)
 @Nullable
default Boolean getDkimSigning()

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

Default: true

getFeedbackForwarding

@Stability(value=Stable)
 @Nullable
default Boolean getFeedbackForwarding()

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

getMailFromBehaviorOnMxFailure

@Stability(value=Stable)
 @Nullable
default MailFromBehaviorOnMxFailure getMailFromBehaviorOnMxFailure()

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

getMailFromDomain

@Stability(value=Stable)
 @Nullable
default String getMailFromDomain()

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

builder

@Stability(value=Stable)
static EmailIdentityProps.Builder builder()

Returns:

a EmailIdentityProps.Builder of EmailIdentityProps