{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SES.Types.RecipientDsnFields
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.SES.Types.RecipientDsnFields where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.SES.Types.DsnAction
import Amazonka.SES.Types.ExtensionField

-- | 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
-- <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html Amazon SES Developer Guide>.
--
-- /See:/ 'newRecipientDsnFields' smart constructor.
data RecipientDsnFields = RecipientDsnFields'
  { -- | An extended explanation of what went wrong; this is usually an SMTP
    -- response. See <https://tools.ietf.org/html/rfc3463 RFC 3463> for the
    -- correct formatting of this parameter.
    RecipientDsnFields -> Maybe Text
diagnosticCode :: Prelude.Maybe Prelude.Text,
    -- | Additional X-headers to include in the DSN.
    RecipientDsnFields -> Maybe [ExtensionField]
extensionFields :: Prelude.Maybe [ExtensionField],
    -- | 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 <https://tools.ietf.org/html/rfc3798 RFC 3798>.
    RecipientDsnFields -> Maybe Text
finalRecipient :: Prelude.Maybe Prelude.Text,
    -- | The time the final delivery attempt was made, in
    -- <https://www.ietf.org/rfc/rfc0822.txt RFC 822> date-time format.
    RecipientDsnFields -> Maybe ISO8601
lastAttemptDate :: Prelude.Maybe Data.ISO8601,
    -- | The MTA to which the remote MTA attempted to deliver the message,
    -- formatted as specified in <https://tools.ietf.org/html/rfc3464 RFC 3464>
    -- (@mta-name-type; mta-name@). This parameter typically applies only to
    -- propagating synchronous bounces.
    RecipientDsnFields -> Maybe Text
remoteMta :: Prelude.Maybe Prelude.Text,
    -- | 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 <https://tools.ietf.org/html/rfc3464 RFC 3464>.
    RecipientDsnFields -> DsnAction
action :: DsnAction,
    -- | The status code that indicates what went wrong. This is required by
    -- <https://tools.ietf.org/html/rfc3464 RFC 3464>.
    RecipientDsnFields -> Text
status :: Prelude.Text
  }
  deriving (RecipientDsnFields -> RecipientDsnFields -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RecipientDsnFields -> RecipientDsnFields -> Bool
$c/= :: RecipientDsnFields -> RecipientDsnFields -> Bool
== :: RecipientDsnFields -> RecipientDsnFields -> Bool
$c== :: RecipientDsnFields -> RecipientDsnFields -> Bool
Prelude.Eq, ReadPrec [RecipientDsnFields]
ReadPrec RecipientDsnFields
Int -> ReadS RecipientDsnFields
ReadS [RecipientDsnFields]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RecipientDsnFields]
$creadListPrec :: ReadPrec [RecipientDsnFields]
readPrec :: ReadPrec RecipientDsnFields
$creadPrec :: ReadPrec RecipientDsnFields
readList :: ReadS [RecipientDsnFields]
$creadList :: ReadS [RecipientDsnFields]
readsPrec :: Int -> ReadS RecipientDsnFields
$creadsPrec :: Int -> ReadS RecipientDsnFields
Prelude.Read, Int -> RecipientDsnFields -> ShowS
[RecipientDsnFields] -> ShowS
RecipientDsnFields -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RecipientDsnFields] -> ShowS
$cshowList :: [RecipientDsnFields] -> ShowS
show :: RecipientDsnFields -> String
$cshow :: RecipientDsnFields -> String
showsPrec :: Int -> RecipientDsnFields -> ShowS
$cshowsPrec :: Int -> RecipientDsnFields -> ShowS
Prelude.Show, forall x. Rep RecipientDsnFields x -> RecipientDsnFields
forall x. RecipientDsnFields -> Rep RecipientDsnFields x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RecipientDsnFields x -> RecipientDsnFields
$cfrom :: forall x. RecipientDsnFields -> Rep RecipientDsnFields x
Prelude.Generic)

-- |
-- Create a value of 'RecipientDsnFields' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'diagnosticCode', 'recipientDsnFields_diagnosticCode' - An extended explanation of what went wrong; this is usually an SMTP
-- response. See <https://tools.ietf.org/html/rfc3463 RFC 3463> for the
-- correct formatting of this parameter.
--
-- 'extensionFields', 'recipientDsnFields_extensionFields' - Additional X-headers to include in the DSN.
--
-- 'finalRecipient', '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 <https://tools.ietf.org/html/rfc3798 RFC 3798>.
--
-- 'lastAttemptDate', 'recipientDsnFields_lastAttemptDate' - The time the final delivery attempt was made, in
-- <https://www.ietf.org/rfc/rfc0822.txt RFC 822> date-time format.
--
-- 'remoteMta', 'recipientDsnFields_remoteMta' - The MTA to which the remote MTA attempted to deliver the message,
-- formatted as specified in <https://tools.ietf.org/html/rfc3464 RFC 3464>
-- (@mta-name-type; mta-name@). This parameter typically applies only to
-- propagating synchronous bounces.
--
-- 'action', '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 <https://tools.ietf.org/html/rfc3464 RFC 3464>.
--
-- 'status', 'recipientDsnFields_status' - The status code that indicates what went wrong. This is required by
-- <https://tools.ietf.org/html/rfc3464 RFC 3464>.
newRecipientDsnFields ::
  -- | 'action'
  DsnAction ->
  -- | 'status'
  Prelude.Text ->
  RecipientDsnFields
newRecipientDsnFields :: DsnAction -> Text -> RecipientDsnFields
newRecipientDsnFields DsnAction
pAction_ Text
pStatus_ =
  RecipientDsnFields'
    { $sel:diagnosticCode:RecipientDsnFields' :: Maybe Text
diagnosticCode =
        forall a. Maybe a
Prelude.Nothing,
      $sel:extensionFields:RecipientDsnFields' :: Maybe [ExtensionField]
extensionFields = forall a. Maybe a
Prelude.Nothing,
      $sel:finalRecipient:RecipientDsnFields' :: Maybe Text
finalRecipient = forall a. Maybe a
Prelude.Nothing,
      $sel:lastAttemptDate:RecipientDsnFields' :: Maybe ISO8601
lastAttemptDate = forall a. Maybe a
Prelude.Nothing,
      $sel:remoteMta:RecipientDsnFields' :: Maybe Text
remoteMta = forall a. Maybe a
Prelude.Nothing,
      $sel:action:RecipientDsnFields' :: DsnAction
action = DsnAction
pAction_,
      $sel:status:RecipientDsnFields' :: Text
status = Text
pStatus_
    }

-- | An extended explanation of what went wrong; this is usually an SMTP
-- response. See <https://tools.ietf.org/html/rfc3463 RFC 3463> for the
-- correct formatting of this parameter.
recipientDsnFields_diagnosticCode :: Lens.Lens' RecipientDsnFields (Prelude.Maybe Prelude.Text)
recipientDsnFields_diagnosticCode :: Lens' RecipientDsnFields (Maybe Text)
recipientDsnFields_diagnosticCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {Maybe Text
diagnosticCode :: Maybe Text
$sel:diagnosticCode:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
diagnosticCode} -> Maybe Text
diagnosticCode) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} Maybe Text
a -> RecipientDsnFields
s {$sel:diagnosticCode:RecipientDsnFields' :: Maybe Text
diagnosticCode = Maybe Text
a} :: RecipientDsnFields)

-- | Additional X-headers to include in the DSN.
recipientDsnFields_extensionFields :: Lens.Lens' RecipientDsnFields (Prelude.Maybe [ExtensionField])
recipientDsnFields_extensionFields :: Lens' RecipientDsnFields (Maybe [ExtensionField])
recipientDsnFields_extensionFields = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {Maybe [ExtensionField]
extensionFields :: Maybe [ExtensionField]
$sel:extensionFields:RecipientDsnFields' :: RecipientDsnFields -> Maybe [ExtensionField]
extensionFields} -> Maybe [ExtensionField]
extensionFields) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} Maybe [ExtensionField]
a -> RecipientDsnFields
s {$sel:extensionFields:RecipientDsnFields' :: Maybe [ExtensionField]
extensionFields = Maybe [ExtensionField]
a} :: RecipientDsnFields) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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 <https://tools.ietf.org/html/rfc3798 RFC 3798>.
recipientDsnFields_finalRecipient :: Lens.Lens' RecipientDsnFields (Prelude.Maybe Prelude.Text)
recipientDsnFields_finalRecipient :: Lens' RecipientDsnFields (Maybe Text)
recipientDsnFields_finalRecipient = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {Maybe Text
finalRecipient :: Maybe Text
$sel:finalRecipient:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
finalRecipient} -> Maybe Text
finalRecipient) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} Maybe Text
a -> RecipientDsnFields
s {$sel:finalRecipient:RecipientDsnFields' :: Maybe Text
finalRecipient = Maybe Text
a} :: RecipientDsnFields)

-- | The time the final delivery attempt was made, in
-- <https://www.ietf.org/rfc/rfc0822.txt RFC 822> date-time format.
recipientDsnFields_lastAttemptDate :: Lens.Lens' RecipientDsnFields (Prelude.Maybe Prelude.UTCTime)
recipientDsnFields_lastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime)
recipientDsnFields_lastAttemptDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {Maybe ISO8601
lastAttemptDate :: Maybe ISO8601
$sel:lastAttemptDate:RecipientDsnFields' :: RecipientDsnFields -> Maybe ISO8601
lastAttemptDate} -> Maybe ISO8601
lastAttemptDate) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} Maybe ISO8601
a -> RecipientDsnFields
s {$sel:lastAttemptDate:RecipientDsnFields' :: Maybe ISO8601
lastAttemptDate = Maybe ISO8601
a} :: RecipientDsnFields) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The MTA to which the remote MTA attempted to deliver the message,
-- formatted as specified in <https://tools.ietf.org/html/rfc3464 RFC 3464>
-- (@mta-name-type; mta-name@). This parameter typically applies only to
-- propagating synchronous bounces.
recipientDsnFields_remoteMta :: Lens.Lens' RecipientDsnFields (Prelude.Maybe Prelude.Text)
recipientDsnFields_remoteMta :: Lens' RecipientDsnFields (Maybe Text)
recipientDsnFields_remoteMta = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {Maybe Text
remoteMta :: Maybe Text
$sel:remoteMta:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
remoteMta} -> Maybe Text
remoteMta) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} Maybe Text
a -> RecipientDsnFields
s {$sel:remoteMta:RecipientDsnFields' :: Maybe Text
remoteMta = Maybe Text
a} :: RecipientDsnFields)

-- | 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 <https://tools.ietf.org/html/rfc3464 RFC 3464>.
recipientDsnFields_action :: Lens.Lens' RecipientDsnFields DsnAction
recipientDsnFields_action :: Lens' RecipientDsnFields DsnAction
recipientDsnFields_action = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {DsnAction
action :: DsnAction
$sel:action:RecipientDsnFields' :: RecipientDsnFields -> DsnAction
action} -> DsnAction
action) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} DsnAction
a -> RecipientDsnFields
s {$sel:action:RecipientDsnFields' :: DsnAction
action = DsnAction
a} :: RecipientDsnFields)

-- | The status code that indicates what went wrong. This is required by
-- <https://tools.ietf.org/html/rfc3464 RFC 3464>.
recipientDsnFields_status :: Lens.Lens' RecipientDsnFields Prelude.Text
recipientDsnFields_status :: Lens' RecipientDsnFields Text
recipientDsnFields_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecipientDsnFields' {Text
status :: Text
$sel:status:RecipientDsnFields' :: RecipientDsnFields -> Text
status} -> Text
status) (\s :: RecipientDsnFields
s@RecipientDsnFields' {} Text
a -> RecipientDsnFields
s {$sel:status:RecipientDsnFields' :: Text
status = Text
a} :: RecipientDsnFields)

instance Prelude.Hashable RecipientDsnFields where
  hashWithSalt :: Int -> RecipientDsnFields -> Int
hashWithSalt Int
_salt RecipientDsnFields' {Maybe [ExtensionField]
Maybe Text
Maybe ISO8601
Text
DsnAction
status :: Text
action :: DsnAction
remoteMta :: Maybe Text
lastAttemptDate :: Maybe ISO8601
finalRecipient :: Maybe Text
extensionFields :: Maybe [ExtensionField]
diagnosticCode :: Maybe Text
$sel:status:RecipientDsnFields' :: RecipientDsnFields -> Text
$sel:action:RecipientDsnFields' :: RecipientDsnFields -> DsnAction
$sel:remoteMta:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
$sel:lastAttemptDate:RecipientDsnFields' :: RecipientDsnFields -> Maybe ISO8601
$sel:finalRecipient:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
$sel:extensionFields:RecipientDsnFields' :: RecipientDsnFields -> Maybe [ExtensionField]
$sel:diagnosticCode:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
diagnosticCode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ExtensionField]
extensionFields
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
finalRecipient
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ISO8601
lastAttemptDate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
remoteMta
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DsnAction
action
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
status

instance Prelude.NFData RecipientDsnFields where
  rnf :: RecipientDsnFields -> ()
rnf RecipientDsnFields' {Maybe [ExtensionField]
Maybe Text
Maybe ISO8601
Text
DsnAction
status :: Text
action :: DsnAction
remoteMta :: Maybe Text
lastAttemptDate :: Maybe ISO8601
finalRecipient :: Maybe Text
extensionFields :: Maybe [ExtensionField]
diagnosticCode :: Maybe Text
$sel:status:RecipientDsnFields' :: RecipientDsnFields -> Text
$sel:action:RecipientDsnFields' :: RecipientDsnFields -> DsnAction
$sel:remoteMta:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
$sel:lastAttemptDate:RecipientDsnFields' :: RecipientDsnFields -> Maybe ISO8601
$sel:finalRecipient:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
$sel:extensionFields:RecipientDsnFields' :: RecipientDsnFields -> Maybe [ExtensionField]
$sel:diagnosticCode:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
diagnosticCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [ExtensionField]
extensionFields
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
finalRecipient
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ISO8601
lastAttemptDate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
remoteMta
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DsnAction
action
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
status

instance Data.ToQuery RecipientDsnFields where
  toQuery :: RecipientDsnFields -> QueryString
toQuery RecipientDsnFields' {Maybe [ExtensionField]
Maybe Text
Maybe ISO8601
Text
DsnAction
status :: Text
action :: DsnAction
remoteMta :: Maybe Text
lastAttemptDate :: Maybe ISO8601
finalRecipient :: Maybe Text
extensionFields :: Maybe [ExtensionField]
diagnosticCode :: Maybe Text
$sel:status:RecipientDsnFields' :: RecipientDsnFields -> Text
$sel:action:RecipientDsnFields' :: RecipientDsnFields -> DsnAction
$sel:remoteMta:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
$sel:lastAttemptDate:RecipientDsnFields' :: RecipientDsnFields -> Maybe ISO8601
$sel:finalRecipient:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
$sel:extensionFields:RecipientDsnFields' :: RecipientDsnFields -> Maybe [ExtensionField]
$sel:diagnosticCode:RecipientDsnFields' :: RecipientDsnFields -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"DiagnosticCode" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
diagnosticCode,
        ByteString
"ExtensionFields"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            ( forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member"
                forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [ExtensionField]
extensionFields
            ),
        ByteString
"FinalRecipient" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
finalRecipient,
        ByteString
"LastAttemptDate" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe ISO8601
lastAttemptDate,
        ByteString
"RemoteMta" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
remoteMta,
        ByteString
"Action" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: DsnAction
action,
        ByteString
"Status" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
status
      ]