Package software.amazon.awscdk.services.pinpointemail

Interface CfnIdentity.MailFromAttributesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentity.MailFromAttributesProperty.Jsii$Proxy

Enclosing class:

CfnIdentity

@Stability(Stable)
public static interface CfnIdentity.MailFromAttributesProperty
extends software.amazon.jsii.JsiiSerializable

A list of attributes that are associated with a MAIL FROM domain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpointemail.*;
 MailFromAttributesProperty mailFromAttributesProperty = MailFromAttributesProperty.builder()
         .behaviorOnMxFailure("behaviorOnMxFailure")
         .mailFromDomain("mailFromDomain")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIdentity.MailFromAttributesProperty.Builder	builder()
default String	getBehaviorOnMxFailure()	The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain.
default String	getMailFromDomain()	The name of a domain that an email identity uses as a custom MAIL FROM domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBehaviorOnMxFailure

@Stability(Stable)
@Nullable
default String getBehaviorOnMxFailure()

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain.

When you set this value to UseDefaultValue , Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states.

getMailFromDomain

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

The name of a domain that an email identity uses as a custom MAIL FROM domain.

builder

@Stability(Stable)
static CfnIdentity.MailFromAttributesProperty.Builder builder()

Returns:

a CfnIdentity.MailFromAttributesProperty.Builder of CfnIdentity.MailFromAttributesProperty