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(value="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 and Description
static interface	PutEmailIdentityMailFromAttributesRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	mailFromDomain() The custom MAIL FROM domain that you want the verified identity to use.
List<SdkField<?>>	sdkFields()
static Class<? extends PutEmailIdentityMailFromAttributesRequest.Builder>	serializableBuilderClass()
PutEmailIdentityMailFromAttributesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

emailIdentity

public 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 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 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>

Specified by:

toBuilder in class PinpointEmailRequest

Returns:

a builder for type T

builder

public static PutEmailIdentityMailFromAttributesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.