Package software.amazon.awssdk.services.pinpointemail.model

Class PutEmailIdentityMailFromAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pinpointemail.model.PinpointEmailRequest

software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityMailFromAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutEmailIdentityMailFromAttributesRequest
extends PinpointEmailRequest
implements ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>

A request to configure the custom MAIL FROM domain for a verified identity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutEmailIdentityMailFromAttributesRequest.Builder

Method Summary

Modifier and Type	Method	Description
BehaviorOnMxFailure	behaviorOnMxFailure()	The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email.
String	behaviorOnMxFailureAsString()	The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email.
static PutEmailIdentityMailFromAttributesRequest.Builder	builder()
String	emailIdentity()	The verified email identity that you want to set up the custom MAIL FROM domain for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	mailFromDomain()	The custom MAIL FROM domain that you want the verified identity to use.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutEmailIdentityMailFromAttributesRequest.Builder>	serializableBuilderClass()
PutEmailIdentityMailFromAttributesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

emailIdentity

public final String emailIdentity()

The verified email identity that you want to set up the custom MAIL FROM domain for.

Returns:

The verified email identity that you want to set up the custom MAIL FROM domain for.

mailFromDomain

public final String mailFromDomain()

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.

Returns:

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.

behaviorOnMxFailure

public final BehaviorOnMxFailure behaviorOnMxFailure()

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. 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.

If the service returns an enum value that is not available in the current SDK version, behaviorOnMxFailure will return BehaviorOnMxFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from behaviorOnMxFailureAsString().

Returns:

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. 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.

See Also:

BehaviorOnMxFailure

behaviorOnMxFailureAsString

public final String behaviorOnMxFailureAsString()

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. 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.

If the service returns an enum value that is not available in the current SDK version, behaviorOnMxFailure will return BehaviorOnMxFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from behaviorOnMxFailureAsString().

Returns:

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. 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.

See Also:

BehaviorOnMxFailure

toBuilder

public PutEmailIdentityMailFromAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>

Specified by:

toBuilder in class PinpointEmailRequest

builder

public static PutEmailIdentityMailFromAttributesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutEmailIdentityMailFromAttributesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo