Package software.amazon.awssdk.services.ses.model

Class SetIdentityMailFromDomainRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SetIdentityMailFromDomainRequest.Builder,SetIdentityMailFromDomainRequest>

@Generated("software.amazon.awssdk:codegen")
public class SetIdentityMailFromDomainRequest
extends AmazonWebServiceRequest
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	Description
static interface	SetIdentityMailFromDomainRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	behaviorOnMXFailure()	The action that you want 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)
int	hashCode()
String	identity()	The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
String	mailFromDomain()	The custom MAIL FROM domain that you want the verified identity to use.
static Class<? extends SetIdentityMailFromDomainRequest.Builder>	serializableBuilderClass()
SetIdentityMailFromDomainRequest.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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

identity

public String identity()

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

Returns:

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

mailFromDomain

public String mailFromDomain()

The custom MAIL FROM domain that you want 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 that you want 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 String behaviorOnMXFailure()

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return 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.

Returns:

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return 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()

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<SetIdentityMailFromDomainRequest.Builder,SetIdentityMailFromDomainRequest>

Returns:

a builder for type T

builder

public static SetIdentityMailFromDomainRequest.Builder builder()

serializableBuilderClass

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