Class MailFromAttributes

    • Method Detail

      • mailFromDomain

        public final String mailFromDomain()

        The name of a domain that an email identity uses as a custom MAIL FROM domain.

        Returns:
        The name of a domain that an email identity uses as a custom MAIL FROM domain.
      • mailFromDomainStatus

        public final MailFromDomainStatus mailFromDomainStatus()

        The status of the MAIL FROM domain. This status can have the following values:

        • PENDING – Amazon SES hasn't started searching for the MX record yet.

        • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

        • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

        • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

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

        Returns:
        The status of the MAIL FROM domain. This status can have the following values:

        • PENDING – Amazon SES hasn't started searching for the MX record yet.

        • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

        • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

        • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

        See Also:
        MailFromDomainStatus
      • mailFromDomainStatusAsString

        public final String mailFromDomainStatusAsString()

        The status of the MAIL FROM domain. This status can have the following values:

        • PENDING – Amazon SES hasn't started searching for the MX record yet.

        • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

        • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

        • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

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

        Returns:
        The status of the MAIL FROM domain. This status can have the following values:

        • PENDING – Amazon SES hasn't started searching for the MX record yet.

        • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

        • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

        • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

        See Also:
        MailFromDomainStatus
      • behaviorOnMxFailure

        public final BehaviorOnMxFailure behaviorOnMxFailure()

        The action to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

        These behaviors are taken when the custom MAIL FROM domain configuration 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 to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

        These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

        See Also:
        BehaviorOnMxFailure
      • behaviorOnMxFailureAsString

        public final String behaviorOnMxFailureAsString()

        The action to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

        These behaviors are taken when the custom MAIL FROM domain configuration 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 to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

        These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

        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)