Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

MailFromAttributes

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

Contents

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.

Type: String

Valid Values: USE_DEFAULT_VALUE | REJECT_MESSAGE

Required: Yes

MailFromDomain

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

Type: String

Required: Yes

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.

Type: String

Valid Values: PENDING | SUCCESS | FAILED | TEMPORARY_FAILURE

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: