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

Class: Aws::PinpointEmail::Types::PutEmailIdentityMailFromAttributesRequest

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

Overview

Note:

When passing PutEmailIdentityMailFromAttributesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  email_identity: "Identity", # required
  mail_from_domain: "MailFromDomainName",
  behavior_on_mx_failure: "USE_DEFAULT_VALUE", # accepts USE_DEFAULT_VALUE, REJECT_MESSAGE
}

A request to configure the custom MAIL FROM domain for a verified identity.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failure ⇒ String

The action that you want Amazon Pinpoint to take if it can\'t read the required MX record when you send an email. 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 you want Amazon Pinpoint to take if it can\'t read the required MX record when you send an email.

#email_identity ⇒ String

The verified email identity that you want to set up the custom MAIL FROM domain for.

Returns:

  • (String) —

    The verified email identity that you want to set up the custom MAIL FROM domain for.

#mail_from_domain ⇒ String

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

  • It has to be a subdomain of the verified identity.

  • It can\'t be used to receive email.

  • It can\'t be used in a \"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails.

Returns:

  • (String) —

    The custom MAIL FROM domain that you want the verified identity to use.