Amazonka.SES.Types.BounceAction

Documentation

data BounceAction

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.

See: newBounceAction smart constructor.

Constructors

BounceAction'

Fields

• statusCode :: Maybe Text

  The SMTP enhanced status code, as defined by RFC 3463.

• topicArn :: Maybe Text

  The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

• smtpReplyCode :: Text

  The SMTP reply code, as defined by RFC 5321.

• message :: Text

  Human-readable text to include in the bounce message.

• sender :: Text

  The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

Instances

ToQuery BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

toQuery :: BounceAction -> QueryString

FromXML BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

parseXML :: [Node] -> Either String BounceAction

Generic BounceAction

Defined in Amazonka.SES.Types.BounceAction

Associated Types

type Rep BounceAction :: Type -> Type

Methods

from :: BounceAction -> Rep BounceAction x

to :: Rep BounceAction x -> BounceAction

Read BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

readsPrec :: Int -> ReadS BounceAction

readList :: ReadS [BounceAction]

readPrec :: ReadPrec BounceAction

readListPrec :: ReadPrec [BounceAction]

Show BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

showsPrec :: Int -> BounceAction -> ShowS

show :: BounceAction -> String

showList :: [BounceAction] -> ShowS

NFData BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

rnf :: BounceAction -> ()

Eq BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

(==) :: BounceAction -> BounceAction -> Bool

(/=) :: BounceAction -> BounceAction -> Bool

Hashable BounceAction

Defined in Amazonka.SES.Types.BounceAction

Methods

hashWithSalt :: Int -> BounceAction -> Int

hash :: BounceAction -> Int

type Rep BounceAction

Defined in Amazonka.SES.Types.BounceAction

type Rep BounceAction = D1 ('MetaData "BounceAction" "Amazonka.SES.Types.BounceAction" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "BounceAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "smtpReplyCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newBounceAction

Arguments

:: Text

$sel:smtpReplyCode:BounceAction'

-> Text

$sel:message:BounceAction'

-> Text

$sel:sender:BounceAction'

-> BounceAction

Create a value of BounceAction 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:statusCode:BounceAction', bounceAction_statusCode - The SMTP enhanced status code, as defined by RFC 3463.

$sel:topicArn:BounceAction', bounceAction_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

$sel:smtpReplyCode:BounceAction', bounceAction_smtpReplyCode - The SMTP reply code, as defined by RFC 5321.

$sel:message:BounceAction', bounceAction_message - Human-readable text to include in the bounce message.

$sel:sender:BounceAction', bounceAction_sender - The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

bounceAction_statusCode :: Lens' BounceAction (Maybe Text)

The SMTP enhanced status code, as defined by RFC 3463.

bounceAction_topicArn :: Lens' BounceAction (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

bounceAction_smtpReplyCode :: Lens' BounceAction Text

The SMTP reply code, as defined by RFC 5321.

bounceAction_message :: Lens' BounceAction Text

Human-readable text to include in the bounce message.

bounceAction_sender :: Lens' BounceAction Text

The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.