Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SES.Types.RecipientDsnFields

Description

Documentation

data RecipientDsnFields Source #

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See: newRecipientDsnFields smart constructor.

Constructors

RecipientDsnFields'

Fields

diagnosticCode :: Maybe Text
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
remoteMta :: Maybe Text
The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.
finalRecipient :: Maybe Text
The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.
Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
extensionFields :: Maybe [ExtensionField]
Additional X-headers to include in the DSN.
lastAttemptDate :: Maybe ISO8601
The time the final delivery attempt was made, in RFC 822 date-time format.
action :: DsnAction
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
status :: Text
The status code that indicates what went wrong. This is required by RFC 3464.

Instances

Instances details

Eq RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Methods (==) :: RecipientDsnFields -> RecipientDsnFields -> Bool # (/=) :: RecipientDsnFields -> RecipientDsnFields -> Bool #
Read RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Methods readsPrec :: Int -> ReadS RecipientDsnFields # readList :: ReadS [RecipientDsnFields] # readPrec :: ReadPrec RecipientDsnFields # readListPrec :: ReadPrec [RecipientDsnFields] #
Show RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Methods showsPrec :: Int -> RecipientDsnFields -> ShowS # show :: RecipientDsnFields -> String # showList :: [RecipientDsnFields] -> ShowS #
Generic RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Associated Types type Rep RecipientDsnFields :: Type -> Type # Methods from :: RecipientDsnFields -> Rep RecipientDsnFields x # to :: Rep RecipientDsnFields x -> RecipientDsnFields #
NFData RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Methods rnf :: RecipientDsnFields -> () #
Hashable RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Methods hashWithSalt :: Int -> RecipientDsnFields -> Int # hash :: RecipientDsnFields -> Int #
ToQuery RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields Methods toQuery :: RecipientDsnFields -> QueryString #
type Rep RecipientDsnFields Source #
Instance details Defined in Amazonka.SES.Types.RecipientDsnFields type Rep RecipientDsnFields = D1 ('MetaData "RecipientDsnFields" "Amazonka.SES.Types.RecipientDsnFields" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "RecipientDsnFields'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "diagnosticCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "remoteMta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "finalRecipient") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "extensionFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExtensionField])) :: S1 ('MetaSel ('Just "lastAttemptDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DsnAction) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRecipientDsnFields Source #

Arguments

:: DsnAction	`$sel:action:RecipientDsnFields'`
-> Text	`$sel:status:RecipientDsnFields'`
-> RecipientDsnFields

Create a value of RecipientDsnFields 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:diagnosticCode:RecipientDsnFields', recipientDsnFields_diagnosticCode - An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

$sel:remoteMta:RecipientDsnFields', recipientDsnFields_remoteMta - The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

$sel:finalRecipient:RecipientDsnFields', recipientDsnFields_finalRecipient - The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

$sel:extensionFields:RecipientDsnFields', recipientDsnFields_extensionFields - Additional X-headers to include in the DSN.

$sel:lastAttemptDate:RecipientDsnFields', recipientDsnFields_lastAttemptDate - The time the final delivery attempt was made, in RFC 822 date-time format.

$sel:action:RecipientDsnFields', recipientDsnFields_action - The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

$sel:status:RecipientDsnFields', recipientDsnFields_status - The status code that indicates what went wrong. This is required by RFC 3464.

recipientDsnFields_diagnosticCode :: Lens' RecipientDsnFields (Maybe Text) Source #

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

recipientDsnFields_remoteMta :: Lens' RecipientDsnFields (Maybe Text) Source #

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

recipientDsnFields_finalRecipient :: Lens' RecipientDsnFields (Maybe Text) Source #

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

recipientDsnFields_extensionFields :: Lens' RecipientDsnFields (Maybe [ExtensionField]) Source #

Additional X-headers to include in the DSN.

recipientDsnFields_lastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime) Source #

The time the final delivery attempt was made, in RFC 822 date-time format.

recipientDsnFields_action :: Lens' RecipientDsnFields DsnAction Source #

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

recipientDsnFields_status :: Lens' RecipientDsnFields Text Source #

The status code that indicates what went wrong. This is required by RFC 3464.