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

Class: Aws::SES::Types::SetIdentityHeadersInNotificationsEnabledRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetIdentityHeadersInNotificationsEnabledRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  identity: "Identity", # required
  notification_type: "Bounce", # required, accepts Bounce, Complaint, Delivery
  enabled: false, # required
}

Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

Returns:

  • (Boolean) —

    Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type.

#identity ⇒ String

The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

Returns:

  • (String) —

    The identity for which to enable or disable headers in notifications.

#notification_type ⇒ String

The notification type for which to enable or disable headers in notifications.

Possible values:

  • Bounce
  • Complaint
  • Delivery

Returns:

  • (String) —

    The notification type for which to enable or disable headers in notifications.