Skip to content

/AWS1/CL_PPEMAILFROMATTRIBUTES

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_mailfromdomain TYPE /AWS1/PPEMAILFROMDOMAINNAME /AWS1/PPEMAILFROMDOMAINNAME

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

iv_mailfromdomainstatus TYPE /AWS1/PPEMAILFROMDOMAINSTATUS /AWS1/PPEMAILFROMDOMAINSTATUS

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.

iv_behavioronmxfailure TYPE /AWS1/PPEBEHAVIORONMXFAILURE /AWS1/PPEBEHAVIORONMXFAILURE

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.

Queryable Attributes

MailFromDomain

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

Accessible with the following methods

Method Description
GET_MAILFROMDOMAIN() Getter for MAILFROMDOMAIN, with configurable default
ASK_MAILFROMDOMAIN() Getter for MAILFROMDOMAIN w/ exceptions if field has no valu
HAS_MAILFROMDOMAIN() Determine if MAILFROMDOMAIN has a value

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.

Accessible with the following methods

Method Description
GET_MAILFROMDOMAINSTATUS() Getter for MAILFROMDOMAINSTATUS, with configurable default
ASK_MAILFROMDOMAINSTATUS() Getter for MAILFROMDOMAINSTATUS w/ exceptions if field has n
HAS_MAILFROMDOMAINSTATUS() Determine if MAILFROMDOMAINSTATUS has a value

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.

Accessible with the following methods

Method Description
GET_BEHAVIORONMXFAILURE() Getter for BEHAVIORONMXFAILURE, with configurable default
ASK_BEHAVIORONMXFAILURE() Getter for BEHAVIORONMXFAILURE w/ exceptions if field has no
HAS_BEHAVIORONMXFAILURE() Determine if BEHAVIORONMXFAILURE has a value