libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Description

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Synopsis

Creating a Request

data PutEmailIdentityFeedbackAttributes Source #

A request to set the attributes that control how bounce and complaint events are processed.

See: newPutEmailIdentityFeedbackAttributes smart constructor.

Constructors

PutEmailIdentityFeedbackAttributes' 

Fields

  • emailForwardingEnabled :: Maybe Bool

    Sets the feedback forwarding configuration for the identity.

    If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

    When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

  • emailIdentity :: Text

    The email identity that you want to configure bounce and complaint feedback forwarding for.

Instances

Instances details
Eq PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Read PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Show PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Generic PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Associated Types

type Rep PutEmailIdentityFeedbackAttributes :: Type -> Type #

NFData PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Hashable PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

ToJSON PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

AWSRequest PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

ToHeaders PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

ToPath PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

ToQuery PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

type Rep PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

type Rep PutEmailIdentityFeedbackAttributes = D1 ('MetaData "PutEmailIdentityFeedbackAttributes" "Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "PutEmailIdentityFeedbackAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "emailForwardingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "emailIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse PutEmailIdentityFeedbackAttributes Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

newPutEmailIdentityFeedbackAttributes Source #

Create a value of PutEmailIdentityFeedbackAttributes 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:emailForwardingEnabled:PutEmailIdentityFeedbackAttributes', putEmailIdentityFeedbackAttributes_emailForwardingEnabled - Sets the feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

$sel:emailIdentity:PutEmailIdentityFeedbackAttributes', putEmailIdentityFeedbackAttributes_emailIdentity - The email identity that you want to configure bounce and complaint feedback forwarding for.

Request Lenses

putEmailIdentityFeedbackAttributes_emailForwardingEnabled :: Lens' PutEmailIdentityFeedbackAttributes (Maybe Bool) Source #

Sets the feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

putEmailIdentityFeedbackAttributes_emailIdentity :: Lens' PutEmailIdentityFeedbackAttributes Text Source #

The email identity that you want to configure bounce and complaint feedback forwarding for.

Destructuring the Response

data PutEmailIdentityFeedbackAttributesResponse Source #

An HTTP 200 response if the request succeeds, or an error message if the request fails.

See: newPutEmailIdentityFeedbackAttributesResponse smart constructor.

Constructors

PutEmailIdentityFeedbackAttributesResponse' 

Fields

Instances

Instances details
Eq PutEmailIdentityFeedbackAttributesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Read PutEmailIdentityFeedbackAttributesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Show PutEmailIdentityFeedbackAttributesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

Generic PutEmailIdentityFeedbackAttributesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

NFData PutEmailIdentityFeedbackAttributesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

type Rep PutEmailIdentityFeedbackAttributesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes

type Rep PutEmailIdentityFeedbackAttributesResponse = D1 ('MetaData "PutEmailIdentityFeedbackAttributesResponse" "Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "PutEmailIdentityFeedbackAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutEmailIdentityFeedbackAttributesResponse Source #

Create a value of PutEmailIdentityFeedbackAttributesResponse 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:PutEmailIdentityFeedbackAttributesResponse', putEmailIdentityFeedbackAttributesResponse_httpStatus - The response's http status code.

Response Lenses