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

Class: Aws::SES::Types::SetIdentityMailFromDomainRequest

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

Overview

Note:

When making an API call, you may pass SetIdentityMailFromDomainRequest data as a hash:

{
  identity: "Identity", # required
  mail_from_domain: "MailFromDomainName",
  behavior_on_mx_failure: "UseDefaultValue", # accepts UseDefaultValue, RejectMessage
}

Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failureString

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

Returns:

  • (String)


4966
4967
4968
4969
4970
4971
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4966

class SetIdentityMailFromDomainRequest < Struct.new(
  :identity,
  :mail_from_domain,
  :behavior_on_mx_failure)
  include Aws::Structure
end

#identityString

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

Returns:

  • (String)


4966
4967
4968
4969
4970
4971
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4966

class SetIdentityMailFromDomainRequest < Struct.new(
  :identity,
  :mail_from_domain,
  :behavior_on_mx_failure)
  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 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

Returns:

  • (String)


4966
4967
4968
4969
4970
4971
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4966

class SetIdentityMailFromDomainRequest < Struct.new(
  :identity,
  :mail_from_domain,
  :behavior_on_mx_failure)
  include Aws::Structure
end