Class IdentityMailFromDomainAttributes

    • 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 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:
        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 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:
        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 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:
        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 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:
        BehaviorOnMXFailure
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)