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:

  • Method Details

    • 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 by BehaviorOnMXFailure.

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

      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 by BehaviorOnMXFailure.
      See Also:

    • 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 by BehaviorOnMXFailure.

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

      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 by BehaviorOnMXFailure.
      See Also:

    • 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 UseDefaultValue indicates 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 of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      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 Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates 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 of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      See Also:

    • 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 UseDefaultValue indicates 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 of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      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 Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates 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 of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      See Also:

    • toBuilder

      public IdentityMailFromDomainAttributes.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<IdentityMailFromDomainAttributes.Builder,IdentityMailFromDomainAttributes>
      Returns:
      a builder for type T

    • builder

      public static IdentityMailFromDomainAttributes.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final 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.