Class: AWSCDK::PinpointEmail::CfnIdentity::MailFromAttributesProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::PinpointEmail::CfnIdentity::MailFromAttributesProperty

Defined in:

pinpoint_email/cfn_identity.rb

Overview

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-mailfromattributes.html

Instance Attribute Summary

• #behavior_on_mx_failure ⇒ String^? readonly

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

• #mail_from_domain ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(behavior_on_mx_failure: nil, mail_from_domain: nil) ⇒ MailFromAttributesProperty constructor

  A new instance of MailFromAttributesProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(behavior_on_mx_failure: nil, mail_from_domain: nil) ⇒ MailFromAttributesProperty

Returns a new instance of MailFromAttributesProperty.

Parameters:

• behavior_on_mx_failure (String, nil) (defaults to: nil) —

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

• mail_from_domain (String, nil) (defaults to: nil) —

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

# File 'pinpoint_email/cfn_identity.rb', line 620

def initialize(behavior_on_mx_failure: nil, mail_from_domain: nil)
  @behavior_on_mx_failure = behavior_on_mx_failure
  Jsii::Type.check_type(@behavior_on_mx_failure, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "behaviorOnMxFailure") unless @behavior_on_mx_failure.nil?
  @mail_from_domain = mail_from_domain
  Jsii::Type.check_type(@mail_from_domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mailFromDomain") unless @mail_from_domain.nil?
end

Instance Attribute Details

#behavior_on_mx_failure ⇒ String^? (readonly)

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, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-mailfromattributes.html#cfn-pinpointemail-identity-mailfromattributes-behavioronmxfailure

# File 'pinpoint_email/cfn_identity.rb', line 635

def behavior_on_mx_failure
  @behavior_on_mx_failure
end

#mail_from_domain ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-mailfromattributes.html#cfn-pinpointemail-identity-mailfromattributes-mailfromdomain

# File 'pinpoint_email/cfn_identity.rb', line 640

def mail_from_domain
  @mail_from_domain
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pinpoint_email/cfn_identity.rb', line 642

def self.jsii_properties
  {
    :behavior_on_mx_failure => "behaviorOnMxFailure",
    :mail_from_domain => "mailFromDomain",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pinpoint_email/cfn_identity.rb', line 649

def to_jsii
  result = {}
  result.merge!({
    "behaviorOnMxFailure" => @behavior_on_mx_failure,
    "mailFromDomain" => @mail_from_domain,
  })
  result.compact
end