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

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 SetIdentityHeadersInNotificationsEnabledRequest data as a 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].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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)


4906
4907
4908
4909
4910
4911
# File 'lib/aws-sdk-ses/types.rb', line 4906

class SetIdentityHeadersInNotificationsEnabledRequest < Struct.new(
  :identity,
  :notification_type,
  :enabled)
  include Aws::Structure
end

#identityString

The identity for which to enable or disable headers in notifications. Examples: ‘[email protected]`, `example.com`.

Returns:

  • (String)


4906
4907
4908
4909
4910
4911
# File 'lib/aws-sdk-ses/types.rb', line 4906

class SetIdentityHeadersInNotificationsEnabledRequest < Struct.new(
  :identity,
  :notification_type,
  :enabled)
  include Aws::Structure
end

#notification_typeString

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

Returns:

  • (String)


4906
4907
4908
4909
4910
4911
# File 'lib/aws-sdk-ses/types.rb', line 4906

class SetIdentityHeadersInNotificationsEnabledRequest < Struct.new(
  :identity,
  :notification_type,
  :enabled)
  include Aws::Structure
end