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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failure ⇒ String

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:

  • (String) 


2120
2121
2122
2123
2124
2125
2126
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2120

class MailFromAttributes < Struct.new(
  :mail_from_domain,
  :mail_from_domain_status,
  :behavior_on_mx_failure)
  SENSITIVE = []
  include Aws::Structure
end

#mail_from_domain ⇒ String

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

Returns:

  • (String) 


2120
2121
2122
2123
2124
2125
2126
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2120

class MailFromAttributes < Struct.new(
  :mail_from_domain,
  :mail_from_domain_status,
  :behavior_on_mx_failure)
  SENSITIVE = []
  include Aws::Structure
end

#mail_from_domain_status ⇒ String

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:

  • (String) 


2120
2121
2122
2123
2124
2125
2126
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2120

class MailFromAttributes < Struct.new(
  :mail_from_domain,
  :mail_from_domain_status,
  :behavior_on_mx_failure)
  SENSITIVE = []
  include Aws::Structure
end