{-# 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.ReceiptFilter
-- 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.ReceiptFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.SES.Types.ReceiptIpFilter

-- | A receipt IP address filter enables you to specify whether to accept or
-- reject mail originating from an IP address or range of IP addresses.
--
-- For information about setting up IP address filters, see the
-- <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html Amazon SES Developer Guide>.
--
-- /See:/ 'newReceiptFilter' smart constructor.
data ReceiptFilter = ReceiptFilter'
  { -- | The name of the IP address filter. The name must:
    --
    -- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
    --     underscores (_), or dashes (-).
    --
    -- -   Start and end with a letter or number.
    --
    -- -   Contain less than 64 characters.
    ReceiptFilter -> Text
name :: Prelude.Text,
    -- | A structure that provides the IP addresses to block or allow, and
    -- whether to block or allow incoming mail from them.
    ReceiptFilter -> ReceiptIpFilter
ipFilter :: ReceiptIpFilter
  }
  deriving (ReceiptFilter -> ReceiptFilter -> Bool
(ReceiptFilter -> ReceiptFilter -> Bool)
-> (ReceiptFilter -> ReceiptFilter -> Bool) -> Eq ReceiptFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ReceiptFilter -> ReceiptFilter -> Bool
$c/= :: ReceiptFilter -> ReceiptFilter -> Bool
== :: ReceiptFilter -> ReceiptFilter -> Bool
$c== :: ReceiptFilter -> ReceiptFilter -> Bool
Prelude.Eq, ReadPrec [ReceiptFilter]
ReadPrec ReceiptFilter
Int -> ReadS ReceiptFilter
ReadS [ReceiptFilter]
(Int -> ReadS ReceiptFilter)
-> ReadS [ReceiptFilter]
-> ReadPrec ReceiptFilter
-> ReadPrec [ReceiptFilter]
-> Read ReceiptFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ReceiptFilter]
$creadListPrec :: ReadPrec [ReceiptFilter]
readPrec :: ReadPrec ReceiptFilter
$creadPrec :: ReadPrec ReceiptFilter
readList :: ReadS [ReceiptFilter]
$creadList :: ReadS [ReceiptFilter]
readsPrec :: Int -> ReadS ReceiptFilter
$creadsPrec :: Int -> ReadS ReceiptFilter
Prelude.Read, Int -> ReceiptFilter -> ShowS
[ReceiptFilter] -> ShowS
ReceiptFilter -> String
(Int -> ReceiptFilter -> ShowS)
-> (ReceiptFilter -> String)
-> ([ReceiptFilter] -> ShowS)
-> Show ReceiptFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReceiptFilter] -> ShowS
$cshowList :: [ReceiptFilter] -> ShowS
show :: ReceiptFilter -> String
$cshow :: ReceiptFilter -> String
showsPrec :: Int -> ReceiptFilter -> ShowS
$cshowsPrec :: Int -> ReceiptFilter -> ShowS
Prelude.Show, (forall x. ReceiptFilter -> Rep ReceiptFilter x)
-> (forall x. Rep ReceiptFilter x -> ReceiptFilter)
-> Generic ReceiptFilter
forall x. Rep ReceiptFilter x -> ReceiptFilter
forall x. ReceiptFilter -> Rep ReceiptFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ReceiptFilter x -> ReceiptFilter
$cfrom :: forall x. ReceiptFilter -> Rep ReceiptFilter x
Prelude.Generic)

-- |
-- Create a value of 'ReceiptFilter' 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', 'receiptFilter_name' - The name of the IP address filter. The name must:
--
-- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
--     underscores (_), or dashes (-).
--
-- -   Start and end with a letter or number.
--
-- -   Contain less than 64 characters.
--
-- 'ipFilter', 'receiptFilter_ipFilter' - A structure that provides the IP addresses to block or allow, and
-- whether to block or allow incoming mail from them.
newReceiptFilter ::
  -- | 'name'
  Prelude.Text ->
  -- | 'ipFilter'
  ReceiptIpFilter ->
  ReceiptFilter
newReceiptFilter :: Text -> ReceiptIpFilter -> ReceiptFilter
newReceiptFilter Text
pName_ ReceiptIpFilter
pIpFilter_ =
  ReceiptFilter' :: Text -> ReceiptIpFilter -> ReceiptFilter
ReceiptFilter'
    { $sel:name:ReceiptFilter' :: Text
name = Text
pName_,
      $sel:ipFilter:ReceiptFilter' :: ReceiptIpFilter
ipFilter = ReceiptIpFilter
pIpFilter_
    }

-- | The name of the IP address filter. The name must:
--
-- -   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),
--     underscores (_), or dashes (-).
--
-- -   Start and end with a letter or number.
--
-- -   Contain less than 64 characters.
receiptFilter_name :: Lens.Lens' ReceiptFilter Prelude.Text
receiptFilter_name :: (Text -> f Text) -> ReceiptFilter -> f ReceiptFilter
receiptFilter_name = (ReceiptFilter -> Text)
-> (ReceiptFilter -> Text -> ReceiptFilter)
-> Lens ReceiptFilter ReceiptFilter Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReceiptFilter' {Text
name :: Text
$sel:name:ReceiptFilter' :: ReceiptFilter -> Text
name} -> Text
name) (\s :: ReceiptFilter
s@ReceiptFilter' {} Text
a -> ReceiptFilter
s {$sel:name:ReceiptFilter' :: Text
name = Text
a} :: ReceiptFilter)

-- | A structure that provides the IP addresses to block or allow, and
-- whether to block or allow incoming mail from them.
receiptFilter_ipFilter :: Lens.Lens' ReceiptFilter ReceiptIpFilter
receiptFilter_ipFilter :: (ReceiptIpFilter -> f ReceiptIpFilter)
-> ReceiptFilter -> f ReceiptFilter
receiptFilter_ipFilter = (ReceiptFilter -> ReceiptIpFilter)
-> (ReceiptFilter -> ReceiptIpFilter -> ReceiptFilter)
-> Lens ReceiptFilter ReceiptFilter ReceiptIpFilter ReceiptIpFilter
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReceiptFilter' {ReceiptIpFilter
ipFilter :: ReceiptIpFilter
$sel:ipFilter:ReceiptFilter' :: ReceiptFilter -> ReceiptIpFilter
ipFilter} -> ReceiptIpFilter
ipFilter) (\s :: ReceiptFilter
s@ReceiptFilter' {} ReceiptIpFilter
a -> ReceiptFilter
s {$sel:ipFilter:ReceiptFilter' :: ReceiptIpFilter
ipFilter = ReceiptIpFilter
a} :: ReceiptFilter)

instance Core.FromXML ReceiptFilter where
  parseXML :: [Node] -> Either String ReceiptFilter
parseXML [Node]
x =
    Text -> ReceiptIpFilter -> ReceiptFilter
ReceiptFilter'
      (Text -> ReceiptIpFilter -> ReceiptFilter)
-> Either String Text
-> Either String (ReceiptIpFilter -> ReceiptFilter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x [Node] -> Text -> Either String Text
forall a. FromXML a => [Node] -> Text -> Either String a
Core..@ Text
"Name") Either String (ReceiptIpFilter -> ReceiptFilter)
-> Either String ReceiptIpFilter -> Either String ReceiptFilter
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x [Node] -> Text -> Either String ReceiptIpFilter
forall a. FromXML a => [Node] -> Text -> Either String a
Core..@ Text
"IpFilter")

instance Prelude.Hashable ReceiptFilter

instance Prelude.NFData ReceiptFilter

instance Core.ToQuery ReceiptFilter where
  toQuery :: ReceiptFilter -> QueryString
toQuery ReceiptFilter' {Text
ReceiptIpFilter
ipFilter :: ReceiptIpFilter
name :: Text
$sel:ipFilter:ReceiptFilter' :: ReceiptFilter -> ReceiptIpFilter
$sel:name:ReceiptFilter' :: ReceiptFilter -> 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
"IpFilter" ByteString -> ReceiptIpFilter -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: ReceiptIpFilter
ipFilter]