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

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

-- | 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:/ 'newReceiptIpFilter' smart constructor.
data ReceiptIpFilter = ReceiptIpFilter'
  { -- | Indicates whether to block or allow incoming mail from the specified IP
    -- addresses.
    ReceiptIpFilter -> ReceiptFilterPolicy
policy :: ReceiptFilterPolicy,
    -- | A single IP address or a range of IP addresses that you want to block or
    -- allow, specified in Classless Inter-Domain Routing (CIDR) notation. An
    -- example of a single email address is 10.0.0.1. An example of a range of
    -- IP addresses is 10.0.0.1\/24. For more information about CIDR notation,
    -- see <https://tools.ietf.org/html/rfc2317 RFC 2317>.
    ReceiptIpFilter -> Text
cidr :: Prelude.Text
  }
  deriving (ReceiptIpFilter -> ReceiptIpFilter -> Bool
(ReceiptIpFilter -> ReceiptIpFilter -> Bool)
-> (ReceiptIpFilter -> ReceiptIpFilter -> Bool)
-> Eq ReceiptIpFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ReceiptIpFilter -> ReceiptIpFilter -> Bool
$c/= :: ReceiptIpFilter -> ReceiptIpFilter -> Bool
== :: ReceiptIpFilter -> ReceiptIpFilter -> Bool
$c== :: ReceiptIpFilter -> ReceiptIpFilter -> Bool
Prelude.Eq, ReadPrec [ReceiptIpFilter]
ReadPrec ReceiptIpFilter
Int -> ReadS ReceiptIpFilter
ReadS [ReceiptIpFilter]
(Int -> ReadS ReceiptIpFilter)
-> ReadS [ReceiptIpFilter]
-> ReadPrec ReceiptIpFilter
-> ReadPrec [ReceiptIpFilter]
-> Read ReceiptIpFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ReceiptIpFilter]
$creadListPrec :: ReadPrec [ReceiptIpFilter]
readPrec :: ReadPrec ReceiptIpFilter
$creadPrec :: ReadPrec ReceiptIpFilter
readList :: ReadS [ReceiptIpFilter]
$creadList :: ReadS [ReceiptIpFilter]
readsPrec :: Int -> ReadS ReceiptIpFilter
$creadsPrec :: Int -> ReadS ReceiptIpFilter
Prelude.Read, Int -> ReceiptIpFilter -> ShowS
[ReceiptIpFilter] -> ShowS
ReceiptIpFilter -> String
(Int -> ReceiptIpFilter -> ShowS)
-> (ReceiptIpFilter -> String)
-> ([ReceiptIpFilter] -> ShowS)
-> Show ReceiptIpFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReceiptIpFilter] -> ShowS
$cshowList :: [ReceiptIpFilter] -> ShowS
show :: ReceiptIpFilter -> String
$cshow :: ReceiptIpFilter -> String
showsPrec :: Int -> ReceiptIpFilter -> ShowS
$cshowsPrec :: Int -> ReceiptIpFilter -> ShowS
Prelude.Show, (forall x. ReceiptIpFilter -> Rep ReceiptIpFilter x)
-> (forall x. Rep ReceiptIpFilter x -> ReceiptIpFilter)
-> Generic ReceiptIpFilter
forall x. Rep ReceiptIpFilter x -> ReceiptIpFilter
forall x. ReceiptIpFilter -> Rep ReceiptIpFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ReceiptIpFilter x -> ReceiptIpFilter
$cfrom :: forall x. ReceiptIpFilter -> Rep ReceiptIpFilter x
Prelude.Generic)

-- |
-- Create a value of 'ReceiptIpFilter' 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:
--
-- 'policy', 'receiptIpFilter_policy' - Indicates whether to block or allow incoming mail from the specified IP
-- addresses.
--
-- 'cidr', 'receiptIpFilter_cidr' - A single IP address or a range of IP addresses that you want to block or
-- allow, specified in Classless Inter-Domain Routing (CIDR) notation. An
-- example of a single email address is 10.0.0.1. An example of a range of
-- IP addresses is 10.0.0.1\/24. For more information about CIDR notation,
-- see <https://tools.ietf.org/html/rfc2317 RFC 2317>.
newReceiptIpFilter ::
  -- | 'policy'
  ReceiptFilterPolicy ->
  -- | 'cidr'
  Prelude.Text ->
  ReceiptIpFilter
newReceiptIpFilter :: ReceiptFilterPolicy -> Text -> ReceiptIpFilter
newReceiptIpFilter ReceiptFilterPolicy
pPolicy_ Text
pCidr_ =
  ReceiptIpFilter' :: ReceiptFilterPolicy -> Text -> ReceiptIpFilter
ReceiptIpFilter' {$sel:policy:ReceiptIpFilter' :: ReceiptFilterPolicy
policy = ReceiptFilterPolicy
pPolicy_, $sel:cidr:ReceiptIpFilter' :: Text
cidr = Text
pCidr_}

-- | Indicates whether to block or allow incoming mail from the specified IP
-- addresses.
receiptIpFilter_policy :: Lens.Lens' ReceiptIpFilter ReceiptFilterPolicy
receiptIpFilter_policy :: (ReceiptFilterPolicy -> f ReceiptFilterPolicy)
-> ReceiptIpFilter -> f ReceiptIpFilter
receiptIpFilter_policy = (ReceiptIpFilter -> ReceiptFilterPolicy)
-> (ReceiptIpFilter -> ReceiptFilterPolicy -> ReceiptIpFilter)
-> Lens
     ReceiptIpFilter
     ReceiptIpFilter
     ReceiptFilterPolicy
     ReceiptFilterPolicy
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReceiptIpFilter' {ReceiptFilterPolicy
policy :: ReceiptFilterPolicy
$sel:policy:ReceiptIpFilter' :: ReceiptIpFilter -> ReceiptFilterPolicy
policy} -> ReceiptFilterPolicy
policy) (\s :: ReceiptIpFilter
s@ReceiptIpFilter' {} ReceiptFilterPolicy
a -> ReceiptIpFilter
s {$sel:policy:ReceiptIpFilter' :: ReceiptFilterPolicy
policy = ReceiptFilterPolicy
a} :: ReceiptIpFilter)

-- | A single IP address or a range of IP addresses that you want to block or
-- allow, specified in Classless Inter-Domain Routing (CIDR) notation. An
-- example of a single email address is 10.0.0.1. An example of a range of
-- IP addresses is 10.0.0.1\/24. For more information about CIDR notation,
-- see <https://tools.ietf.org/html/rfc2317 RFC 2317>.
receiptIpFilter_cidr :: Lens.Lens' ReceiptIpFilter Prelude.Text
receiptIpFilter_cidr :: (Text -> f Text) -> ReceiptIpFilter -> f ReceiptIpFilter
receiptIpFilter_cidr = (ReceiptIpFilter -> Text)
-> (ReceiptIpFilter -> Text -> ReceiptIpFilter)
-> Lens ReceiptIpFilter ReceiptIpFilter Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReceiptIpFilter' {Text
cidr :: Text
$sel:cidr:ReceiptIpFilter' :: ReceiptIpFilter -> Text
cidr} -> Text
cidr) (\s :: ReceiptIpFilter
s@ReceiptIpFilter' {} Text
a -> ReceiptIpFilter
s {$sel:cidr:ReceiptIpFilter' :: Text
cidr = Text
a} :: ReceiptIpFilter)

instance Core.FromXML ReceiptIpFilter where
  parseXML :: [Node] -> Either String ReceiptIpFilter
parseXML [Node]
x =
    ReceiptFilterPolicy -> Text -> ReceiptIpFilter
ReceiptIpFilter'
      (ReceiptFilterPolicy -> Text -> ReceiptIpFilter)
-> Either String ReceiptFilterPolicy
-> Either String (Text -> ReceiptIpFilter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x [Node] -> Text -> Either String ReceiptFilterPolicy
forall a. FromXML a => [Node] -> Text -> Either String a
Core..@ Text
"Policy") Either String (Text -> ReceiptIpFilter)
-> Either String Text -> Either String ReceiptIpFilter
forall (f :: * -> *) a b. Applicative f => 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
"Cidr")

instance Prelude.Hashable ReceiptIpFilter

instance Prelude.NFData ReceiptIpFilter

instance Core.ToQuery ReceiptIpFilter where
  toQuery :: ReceiptIpFilter -> QueryString
toQuery ReceiptIpFilter' {Text
ReceiptFilterPolicy
cidr :: Text
policy :: ReceiptFilterPolicy
$sel:cidr:ReceiptIpFilter' :: ReceiptIpFilter -> Text
$sel:policy:ReceiptIpFilter' :: ReceiptIpFilter -> ReceiptFilterPolicy
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"Policy" ByteString -> ReceiptFilterPolicy -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: ReceiptFilterPolicy
policy, ByteString
"Cidr" ByteString -> Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Text
cidr]