software.amazon.awssdk.services.ses.model

Class SetIdentityMailFromDomainRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ses.model.SesRequest

software.amazon.awssdk.services.ses.model.SetIdentityMailFromDomainRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetIdentityMailFromDomainRequest.Builder,SetIdentityMailFromDomainRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SetIdentityMailFromDomainRequest
extends SesRequest
implements ToCopyableBuilder<SetIdentityMailFromDomainRequest.Builder,SetIdentityMailFromDomainRequest>

Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetIdentityMailFromDomainRequest.Builder

Method Summary

Modifier and Type	Method and Description
BehaviorOnMXFailure	behaviorOnMXFailure() The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email.
String	behaviorOnMXFailureAsString() The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email.
static SetIdentityMailFromDomainRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identity() The verified identity.
String	mailFromDomain() The custom MAIL FROM domain for the verified identity to use.
List<SdkField<?>>	sdkFields()
static Class<? extends SetIdentityMailFromDomainRequest.Builder>	serializableBuilderClass()
SetIdentityMailFromDomainRequest.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

identity

public final String identity()

The verified identity.

Returns:

The verified identity.

mailFromDomain

public final String mailFromDomain()

The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

Returns:

The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

behaviorOnMXFailure

public final BehaviorOnMXFailure behaviorOnMXFailure()

The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup 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 for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

See Also:

BehaviorOnMXFailure

behaviorOnMXFailureAsString

public final String behaviorOnMXFailureAsString()

The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup 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 for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

See Also:

BehaviorOnMXFailure

toBuilder

public SetIdentityMailFromDomainRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetIdentityMailFromDomainRequest.Builder,SetIdentityMailFromDomainRequest>

Specified by:

toBuilder in class SesRequest

builder

public static SetIdentityMailFromDomainRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetIdentityMailFromDomainRequest.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