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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_on_mx_failure ⇒ String

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) 


4970
4971
4972
4973
4974
4975
 
# File 'lib/aws-sdk-ses/types.rb', line 4970

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

#identity ⇒ String

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

Returns:

  • (String) 


4970
4971
4972
4973
4974
4975
 
# File 'lib/aws-sdk-ses/types.rb', line 4970

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

#mail_from_domain ⇒ String

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.

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html

Returns:

  • (String) 


4970
4971
4972
4973
4974
4975
 
# File 'lib/aws-sdk-ses/types.rb', line 4970

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