Interface EmailIdentityProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
EmailIdentityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:25.936Z") @Stability(Stable) public interface EmailIdentityProps extends software.amazon.jsii.JsiiSerializable
Properties for an email identity.

Example:

 import software.amazon.awscdk.services.iam.*;
 User user;
 EmailIdentity identity = EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.domain("cdk.dev"))
         .build();
 identity.grantSendEmail(user);
 
  • Method Details

    • getIdentity

      @Stability(Stable) @NotNull Identity getIdentity()
      The email address or domain to verify.
    • getConfigurationSet

      @Stability(Stable) @Nullable default IConfigurationSet getConfigurationSet()
      The configuration set to associate with the email identity.

      Default: - do not use a specific configuration set

    • getDkimIdentity

      @Stability(Stable) @Nullable default DkimIdentity getDkimIdentity()
      The type of DKIM identity to use.

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

    • getDkimSigning

      @Stability(Stable) @Nullable default Boolean getDkimSigning()
      Whether the messages that are sent from the identity are signed using DKIM.

      Default: true

    • getFeedbackForwarding

      @Stability(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(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(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(Stable) static EmailIdentityProps.Builder builder()
      Returns:
      a EmailIdentityProps.Builder of EmailIdentityProps