Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PinpointEmail::Types::MailFromAttributes

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A list of attributes that are associated with a MAIL FROM domain.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failureString

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.

Possible values:

  • USE_DEFAULT_VALUE
  • REJECT_MESSAGE

Returns:

  • (String)

    The action that Amazon Pinpoint to takes if it can\'t read the required MX record for a custom MAIL FROM domain.

#mail_from_domainString

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

Returns:

  • (String)

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

#mail_from_domain_statusString

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.

    Possible values:

    • PENDING
    • SUCCESS
    • FAILED
    • TEMPORARY_FAILURE

Returns:

  • (String)

    The status of the MAIL FROM domain.