libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.Types.ReceiptRule

Description

 
Synopsis

Documentation

data ReceiptRule Source #

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

See: newReceiptRule smart constructor.

Constructors

ReceiptRule' 

Fields

  • scanEnabled :: Maybe Bool

    If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

  • enabled :: Maybe Bool

    If true, the receipt rule is active. The default value is false.

  • actions :: Maybe [ReceiptAction]

    An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

  • recipients :: Maybe [Text]

    The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

  • tlsPolicy :: Maybe TlsPolicy

    Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

  • name :: Text

    The name of the receipt rule. 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.

Instances

Instances details
Eq ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

(==) :: ReceiptRule -> ReceiptRule -> Bool #

(/=) :: ReceiptRule -> ReceiptRule -> Bool #

Read ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

readsPrec :: Int -> ReadS ReceiptRule #

readList :: ReadS [ReceiptRule] #

readPrec :: ReadPrec ReceiptRule #

readListPrec :: ReadPrec [ReceiptRule] #

Show ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

showsPrec :: Int -> ReceiptRule -> ShowS #

show :: ReceiptRule -> String #

showList :: [ReceiptRule] -> ShowS #

Generic ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Associated Types

type Rep ReceiptRule :: Type -> Type #

Methods

from :: ReceiptRule -> Rep ReceiptRule x #

to :: Rep ReceiptRule x -> ReceiptRule #

NFData ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

rnf :: ReceiptRule -> () #

Hashable ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

hashWithSalt :: Int -> ReceiptRule -> Int #

hash :: ReceiptRule -> Int #

ToQuery ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

toQuery :: ReceiptRule -> QueryString #

FromXML ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

Methods

parseXML :: [Node] -> Either String ReceiptRule #

type Rep ReceiptRule Source # 
Instance details

Defined in Amazonka.SES.Types.ReceiptRule

type Rep ReceiptRule = D1 ('MetaData "ReceiptRule" "Amazonka.SES.Types.ReceiptRule" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "ReceiptRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scanEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReceiptAction])))) :*: (S1 ('MetaSel ('Just "recipients") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "tlsPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsPolicy)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newReceiptRule Source #

Arguments

:: Text

$sel:name:ReceiptRule'

-> ReceiptRule 

Create a value of ReceiptRule 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:scanEnabled:ReceiptRule', receiptRule_scanEnabled - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

$sel:enabled:ReceiptRule', receiptRule_enabled - If true, the receipt rule is active. The default value is false.

$sel:actions:ReceiptRule', receiptRule_actions - An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

$sel:recipients:ReceiptRule', receiptRule_recipients - The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

$sel:tlsPolicy:ReceiptRule', receiptRule_tlsPolicy - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

$sel:name:ReceiptRule', receiptRule_name - The name of the receipt rule. 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.

receiptRule_scanEnabled :: Lens' ReceiptRule (Maybe Bool) Source #

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

receiptRule_enabled :: Lens' ReceiptRule (Maybe Bool) Source #

If true, the receipt rule is active. The default value is false.

receiptRule_actions :: Lens' ReceiptRule (Maybe [ReceiptAction]) Source #

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

receiptRule_recipients :: Lens' ReceiptRule (Maybe [Text]) Source #

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

receiptRule_tlsPolicy :: Lens' ReceiptRule (Maybe TlsPolicy) Source #

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

receiptRule_name :: Lens' ReceiptRule Text Source #

The name of the receipt rule. 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.