Class: Aws::SESV2::Types::PutEmailIdentityMailFromAttributesRequest

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

Overview

Note:

When making an API call, you may pass PutEmailIdentityMailFromAttributesRequest data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failureString

The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 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)


5600
5601
5602
5603
5604
5605
5606
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 5600

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

#email_identityString

The verified email identity.

Returns:

  • (String)


5600
5601
5602
5603
5604
5605
5606
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 5600

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

#mail_from_domainString

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)


5600
5601
5602
5603
5604
5605
5606
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 5600

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