Package software.amazon.awssdk.services.pinpointemail.model

Interface MailFromAttributes.Builder

    • Method Detail

      • mailFromDomain

        MailFromAttributes.Builder mailFromDomain​(String mailFromDomain)

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

        Parameters:
        mailFromDomain - The name of a domain that an email identity uses as a custom MAIL FROM domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mailFromDomainStatus

        MailFromAttributes.Builder mailFromDomainStatus​(String mailFromDomainStatus)

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

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

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

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

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

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

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

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MailFromDomainStatus, MailFromDomainStatus

      • mailFromDomainStatus

        MailFromAttributes.Builder mailFromDomainStatus​(MailFromDomainStatus mailFromDomainStatus)

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

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

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

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

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

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

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

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MailFromDomainStatus, MailFromDomainStatus

      • behaviorOnMxFailure

        MailFromAttributes.Builder behaviorOnMxFailure​(String behaviorOnMxFailure)

        The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

        Parameters:
        behaviorOnMxFailure - The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BehaviorOnMxFailure, BehaviorOnMxFailure

      • behaviorOnMxFailure

        MailFromAttributes.Builder behaviorOnMxFailure​(BehaviorOnMxFailure behaviorOnMxFailure)

        The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

        Parameters:
        behaviorOnMxFailure - The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BehaviorOnMxFailure, BehaviorOnMxFailure