{-# 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.MessageTag
-- 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)
module Amazonka.SES.Types.MessageTag where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Contains the name and value of a tag that you can provide to @SendEmail@
-- or @SendRawEmail@ to apply to an email.
--
-- Message tags, which you use with configuration sets, enable you to
-- publish email sending events. For information about using configuration
-- sets, see the
-- <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html Amazon SES Developer Guide>.
--
-- /See:/ 'newMessageTag' smart constructor.
data MessageTag = MessageTag'
  { -- | The name of the tag. The name must:
    --
    -- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
    --     underscores (_), or dashes (-).
    --
    -- -   Contain less than 256 characters.
    MessageTag -> Text
name :: Prelude.Text,
    -- | The value of the tag. The value must:
    --
    -- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
    --     underscores (_), or dashes (-).
    --
    -- -   Contain less than 256 characters.
    MessageTag -> Text
value :: Prelude.Text
  }
  deriving (MessageTag -> MessageTag -> Bool
(MessageTag -> MessageTag -> Bool)
-> (MessageTag -> MessageTag -> Bool) -> Eq MessageTag
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MessageTag -> MessageTag -> Bool
$c/= :: MessageTag -> MessageTag -> Bool
== :: MessageTag -> MessageTag -> Bool
$c== :: MessageTag -> MessageTag -> Bool
Prelude.Eq, ReadPrec [MessageTag]
ReadPrec MessageTag
Int -> ReadS MessageTag
ReadS [MessageTag]
(Int -> ReadS MessageTag)
-> ReadS [MessageTag]
-> ReadPrec MessageTag
-> ReadPrec [MessageTag]
-> Read MessageTag
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MessageTag]
$creadListPrec :: ReadPrec [MessageTag]
readPrec :: ReadPrec MessageTag
$creadPrec :: ReadPrec MessageTag
readList :: ReadS [MessageTag]
$creadList :: ReadS [MessageTag]
readsPrec :: Int -> ReadS MessageTag
$creadsPrec :: Int -> ReadS MessageTag
Prelude.Read, Int -> MessageTag -> ShowS
[MessageTag] -> ShowS
MessageTag -> String
(Int -> MessageTag -> ShowS)
-> (MessageTag -> String)
-> ([MessageTag] -> ShowS)
-> Show MessageTag
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MessageTag] -> ShowS
$cshowList :: [MessageTag] -> ShowS
show :: MessageTag -> String
$cshow :: MessageTag -> String
showsPrec :: Int -> MessageTag -> ShowS
$cshowsPrec :: Int -> MessageTag -> ShowS
Prelude.Show, (forall x. MessageTag -> Rep MessageTag x)
-> (forall x. Rep MessageTag x -> MessageTag) -> Generic MessageTag
forall x. Rep MessageTag x -> MessageTag
forall x. MessageTag -> Rep MessageTag x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MessageTag x -> MessageTag
$cfrom :: forall x. MessageTag -> Rep MessageTag x
Prelude.Generic)

-- |
-- Create a value of 'MessageTag' 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:
--
-- 'name', 'messageTag_name' - The name of the tag. The name must:
--
-- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
--     underscores (_), or dashes (-).
--
-- -   Contain less than 256 characters.
--
-- 'value', 'messageTag_value' - The value of the tag. The value must:
--
-- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
--     underscores (_), or dashes (-).
--
-- -   Contain less than 256 characters.
newMessageTag ::
  -- | 'name'
  Prelude.Text ->
  -- | 'value'
  Prelude.Text ->
  MessageTag
newMessageTag :: Text -> Text -> MessageTag
newMessageTag Text
pName_ Text
pValue_ =
  MessageTag' :: Text -> Text -> MessageTag
MessageTag' {$sel:name:MessageTag' :: Text
name = Text
pName_, $sel:value:MessageTag' :: Text
value = Text
pValue_}

-- | The name of the tag. The name must:
--
-- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
--     underscores (_), or dashes (-).
--
-- -   Contain less than 256 characters.
messageTag_name :: Lens.Lens' MessageTag Prelude.Text
messageTag_name :: (Text -> f Text) -> MessageTag -> f MessageTag
messageTag_name = (MessageTag -> Text)
-> (MessageTag -> Text -> MessageTag)
-> Lens MessageTag MessageTag Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageTag' {Text
name :: Text
$sel:name:MessageTag' :: MessageTag -> Text
name} -> Text
name) (\s :: MessageTag
s@MessageTag' {} Text
a -> MessageTag
s {$sel:name:MessageTag' :: Text
name = Text
a} :: MessageTag)

-- | The value of the tag. The value must:
--
-- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
--     underscores (_), or dashes (-).
--
-- -   Contain less than 256 characters.
messageTag_value :: Lens.Lens' MessageTag Prelude.Text
messageTag_value :: (Text -> f Text) -> MessageTag -> f MessageTag
messageTag_value = (MessageTag -> Text)
-> (MessageTag -> Text -> MessageTag)
-> Lens MessageTag MessageTag Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageTag' {Text
value :: Text
$sel:value:MessageTag' :: MessageTag -> Text
value} -> Text
value) (\s :: MessageTag
s@MessageTag' {} Text
a -> MessageTag
s {$sel:value:MessageTag' :: Text
value = Text
a} :: MessageTag)

instance Prelude.Hashable MessageTag

instance Prelude.NFData MessageTag

instance Core.ToQuery MessageTag where
  toQuery :: MessageTag -> QueryString
toQuery MessageTag' {Text
value :: Text
name :: Text
$sel:value:MessageTag' :: MessageTag -> Text
$sel:name:MessageTag' :: MessageTag -> Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"Name" ByteString -> Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Text
name, ByteString
"Value" ByteString -> Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Text
value]