amazonka-ses-2.0: Amazon Simple Email Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Description

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Synopsis

Creating a Request

data SetIdentityHeadersInNotificationsEnabled Source #

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: newSetIdentityHeadersInNotificationsEnabled smart constructor.

Constructors

SetIdentityHeadersInNotificationsEnabled' 

Fields

  • identity :: Text

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

  • notificationType :: NotificationType

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

  • enabled :: Bool

    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.

Instances

Instances details
ToHeaders SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

ToPath SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

ToQuery SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

AWSRequest SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Generic SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Read SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Show SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

NFData SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Eq SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Hashable SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

type AWSResponse SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

type Rep SetIdentityHeadersInNotificationsEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

type Rep SetIdentityHeadersInNotificationsEnabled = D1 ('MetaData "SetIdentityHeadersInNotificationsEnabled" "Amazonka.SES.SetIdentityHeadersInNotificationsEnabled" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "SetIdentityHeadersInNotificationsEnabled'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "notificationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotificationType) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newSetIdentityHeadersInNotificationsEnabled Source #

Create a value of SetIdentityHeadersInNotificationsEnabled with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identity:SetIdentityHeadersInNotificationsEnabled', setIdentityHeadersInNotificationsEnabled_identity - The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

$sel:notificationType:SetIdentityHeadersInNotificationsEnabled', setIdentityHeadersInNotificationsEnabled_notificationType - The notification type for which to enable or disable headers in notifications.

SetIdentityHeadersInNotificationsEnabled, setIdentityHeadersInNotificationsEnabled_enabled - 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.

Request Lenses

setIdentityHeadersInNotificationsEnabled_identity :: Lens' SetIdentityHeadersInNotificationsEnabled Text Source #

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

setIdentityHeadersInNotificationsEnabled_notificationType :: Lens' SetIdentityHeadersInNotificationsEnabled NotificationType Source #

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

setIdentityHeadersInNotificationsEnabled_enabled :: Lens' SetIdentityHeadersInNotificationsEnabled Bool Source #

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.

Destructuring the Response

data SetIdentityHeadersInNotificationsEnabledResponse Source #

An empty element returned on a successful request.

See: newSetIdentityHeadersInNotificationsEnabledResponse smart constructor.

Constructors

SetIdentityHeadersInNotificationsEnabledResponse' 

Fields

Instances

Instances details
Generic SetIdentityHeadersInNotificationsEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Read SetIdentityHeadersInNotificationsEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Show SetIdentityHeadersInNotificationsEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

NFData SetIdentityHeadersInNotificationsEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

Eq SetIdentityHeadersInNotificationsEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

type Rep SetIdentityHeadersInNotificationsEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityHeadersInNotificationsEnabled

type Rep SetIdentityHeadersInNotificationsEnabledResponse = D1 ('MetaData "SetIdentityHeadersInNotificationsEnabledResponse" "Amazonka.SES.SetIdentityHeadersInNotificationsEnabled" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "SetIdentityHeadersInNotificationsEnabledResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetIdentityHeadersInNotificationsEnabledResponse Source #

Create a value of SetIdentityHeadersInNotificationsEnabledResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SetIdentityHeadersInNotificationsEnabledResponse', setIdentityHeadersInNotificationsEnabledResponse_httpStatus - The response's http status code.

Response Lenses