Class IdentityMailFromDomainAttributes
- java.lang.Object
-
- software.amazon.awssdk.services.ses.model.IdentityMailFromDomainAttributes
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<IdentityMailFromDomainAttributes.Builder,IdentityMailFromDomainAttributes>
@Generated("software.amazon.awssdk:codegen") public final class IdentityMailFromDomainAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IdentityMailFromDomainAttributes.Builder,IdentityMailFromDomainAttributes>
Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceIdentityMailFromDomainAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BehaviorOnMXFailurebehaviorOnMXFailure()The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email.StringbehaviorOnMXFailureAsString()The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email.static IdentityMailFromDomainAttributes.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringmailFromDomain()The custom MAIL FROM domain that the identity is configured to use.CustomMailFromStatusmailFromDomainStatus()The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup.StringmailFromDomainStatusAsString()The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends IdentityMailFromDomainAttributes.Builder>serializableBuilderClass()IdentityMailFromDomainAttributes.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
mailFromDomain
public final String mailFromDomain()
The custom MAIL FROM domain that the identity is configured to use.
- Returns:
- The custom MAIL FROM domain that the identity is configured to use.
-
mailFromDomainStatus
public final CustomMailFromStatus mailFromDomainStatus()
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is
Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described byBehaviorOnMXFailure.If the service returns an enum value that is not available in the current SDK version,
mailFromDomainStatuswill returnCustomMailFromStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommailFromDomainStatusAsString().- Returns:
- The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL
FROM domain setup. If the state is
Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described byBehaviorOnMXFailure. - See Also:
CustomMailFromStatus
-
mailFromDomainStatusAsString
public final String mailFromDomainStatusAsString()
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is
Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described byBehaviorOnMXFailure.If the service returns an enum value that is not available in the current SDK version,
mailFromDomainStatuswill returnCustomMailFromStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommailFromDomainStatusAsString().- Returns:
- The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL
FROM domain setup. If the state is
Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described byBehaviorOnMXFailure. - See Also:
CustomMailFromStatus
-
behaviorOnMXFailure
public final BehaviorOnMXFailure behaviorOnMXFailure()
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of
UseDefaultValueindicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value ofRejectMessageindicates that if Amazon SES cannot read the required MX record, Amazon SES returns aMailFromDomainNotVerifiederror and does not send the email.The custom MAIL FROM setup states that result in this behavior are
Pending,Failed, andTemporaryFailure.If the service returns an enum value that is not available in the current SDK version,
behaviorOnMXFailurewill returnBehaviorOnMXFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombehaviorOnMXFailureAsString().- Returns:
- The action that Amazon SES takes if it cannot successfully read the required MX record when you send an
email. A value of
UseDefaultValueindicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value ofRejectMessageindicates that if Amazon SES cannot read the required MX record, Amazon SES returns aMailFromDomainNotVerifiederror and does not send the email.The custom MAIL FROM setup states that result in this behavior are
Pending,Failed, andTemporaryFailure. - See Also:
BehaviorOnMXFailure
-
behaviorOnMXFailureAsString
public final String behaviorOnMXFailureAsString()
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of
UseDefaultValueindicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value ofRejectMessageindicates that if Amazon SES cannot read the required MX record, Amazon SES returns aMailFromDomainNotVerifiederror and does not send the email.The custom MAIL FROM setup states that result in this behavior are
Pending,Failed, andTemporaryFailure.If the service returns an enum value that is not available in the current SDK version,
behaviorOnMXFailurewill returnBehaviorOnMXFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombehaviorOnMXFailureAsString().- Returns:
- The action that Amazon SES takes if it cannot successfully read the required MX record when you send an
email. A value of
UseDefaultValueindicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value ofRejectMessageindicates that if Amazon SES cannot read the required MX record, Amazon SES returns aMailFromDomainNotVerifiederror and does not send the email.The custom MAIL FROM setup states that result in this behavior are
Pending,Failed, andTemporaryFailure. - See Also:
BehaviorOnMXFailure
-
toBuilder
public IdentityMailFromDomainAttributes.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<IdentityMailFromDomainAttributes.Builder,IdentityMailFromDomainAttributes>
-
builder
public static IdentityMailFromDomainAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends IdentityMailFromDomainAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-