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

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failure ⇒ String

The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns 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) 


4684
4685
4686
4687
4688
4689
4690
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4684

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

#identity ⇒ String

The verified identity.

Returns:

  • (String) 


4684
4685
4686
4687
4688
4689
4690
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4684

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

#mail_from_domain ⇒ String

The custom MAIL FROM domain for 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) 


4684
4685
4686
4687
4688
4689
4690
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4684

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