Copyright	(c) 2013-2018 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)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SES.SendBounce

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .

You can execute this operation no more than once per second.

Synopsis

Creating a Request

sendBounce #

Arguments

:: Text	`sbOriginalMessageId`
-> Text	`sbBounceSender`
-> SendBounce

Creates a value of SendBounce with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sbMessageDsn - Message-related DSN fields. If not specified, Amazon SES will choose the values.
sbExplanation - Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
sbBounceSenderARN - This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the From header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide .
sbOriginalMessageId - The message ID of the message to be bounced.
sbBounceSender - The address to use in the From header of the bounce message. This must be an identity that you have verified with Amazon SES.
sbBouncedRecipientInfoList - A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

data SendBounce #

Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

See: sendBounce smart constructor.

Instances

Eq SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods (==) :: SendBounce -> SendBounce -> Bool # (/=) :: SendBounce -> SendBounce -> Bool #
Data SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendBounce -> c SendBounce # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendBounce # toConstr :: SendBounce -> Constr # dataTypeOf :: SendBounce -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SendBounce) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendBounce) # gmapT :: (forall b. Data b => b -> b) -> SendBounce -> SendBounce # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendBounce -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendBounce -> r # gmapQ :: (forall d. Data d => d -> u) -> SendBounce -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SendBounce -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendBounce -> m SendBounce # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendBounce -> m SendBounce # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendBounce -> m SendBounce #
Read SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods readsPrec :: Int -> ReadS SendBounce # readList :: ReadS [SendBounce] # readPrec :: ReadPrec SendBounce # readListPrec :: ReadPrec [SendBounce] #
Show SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods showsPrec :: Int -> SendBounce -> ShowS # show :: SendBounce -> String # showList :: [SendBounce] -> ShowS #
Generic SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Associated Types type Rep SendBounce :: Type -> Type # Methods from :: SendBounce -> Rep SendBounce x # to :: Rep SendBounce x -> SendBounce #
Hashable SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods hashWithSalt :: Int -> SendBounce -> Int # hash :: SendBounce -> Int #
AWSRequest SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Associated Types type Rs SendBounce :: Type # Methods request :: SendBounce -> Request SendBounce # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SendBounce -> ClientResponse -> m (Response SendBounce) #
ToHeaders SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods toHeaders :: SendBounce -> [Header] #
ToPath SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods toPath :: SendBounce -> ByteString #
ToQuery SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods toQuery :: SendBounce -> QueryString #
NFData SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce Methods rnf :: SendBounce -> () #
type Rep SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce type Rep SendBounce = D1 (MetaData "SendBounce" "Network.AWS.SES.SendBounce" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "SendBounce'" PrefixI True) ((S1 (MetaSel (Just "_sbMessageDsn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MessageDsn)) :: (S1 (MetaSel (Just "_sbExplanation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sbBounceSenderARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_sbOriginalMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_sbBounceSender") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sbBouncedRecipientInfoList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [BouncedRecipientInfo])))))
type Rs SendBounce #
Instance details Defined in Network.AWS.SES.SendBounce type Rs SendBounce = SendBounceResponse

Request Lenses

sbMessageDsn :: Lens' SendBounce (Maybe MessageDsn) #

Message-related DSN fields. If not specified, Amazon SES will choose the values.

sbExplanation :: Lens' SendBounce (Maybe Text) #

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

sbBounceSenderARN :: Lens' SendBounce (Maybe Text) #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the From header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide .

sbOriginalMessageId :: Lens' SendBounce Text #

The message ID of the message to be bounced.

sbBounceSender :: Lens' SendBounce Text #

The address to use in the From header of the bounce message. This must be an identity that you have verified with Amazon SES.

sbBouncedRecipientInfoList :: Lens' SendBounce [BouncedRecipientInfo] #

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

Destructuring the Response

sendBounceResponse #

Arguments

:: Int	`sbrsResponseStatus`
-> SendBounceResponse

Creates a value of SendBounceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sbrsMessageId - The message ID of the bounce message.
sbrsResponseStatus - -- | The response status code.

data SendBounceResponse #

Represents a unique message ID.

See: sendBounceResponse smart constructor.

Instances

Eq SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce Methods (==) :: SendBounceResponse -> SendBounceResponse -> Bool # (/=) :: SendBounceResponse -> SendBounceResponse -> Bool #
Data SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendBounceResponse -> c SendBounceResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendBounceResponse # toConstr :: SendBounceResponse -> Constr # dataTypeOf :: SendBounceResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SendBounceResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendBounceResponse) # gmapT :: (forall b. Data b => b -> b) -> SendBounceResponse -> SendBounceResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendBounceResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendBounceResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> SendBounceResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SendBounceResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendBounceResponse -> m SendBounceResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendBounceResponse -> m SendBounceResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendBounceResponse -> m SendBounceResponse #
Read SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce Methods readsPrec :: Int -> ReadS SendBounceResponse # readList :: ReadS [SendBounceResponse] # readPrec :: ReadPrec SendBounceResponse # readListPrec :: ReadPrec [SendBounceResponse] #
Show SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce Methods showsPrec :: Int -> SendBounceResponse -> ShowS # show :: SendBounceResponse -> String # showList :: [SendBounceResponse] -> ShowS #
Generic SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce Associated Types type Rep SendBounceResponse :: Type -> Type # Methods from :: SendBounceResponse -> Rep SendBounceResponse x # to :: Rep SendBounceResponse x -> SendBounceResponse #
NFData SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce Methods rnf :: SendBounceResponse -> () #
type Rep SendBounceResponse #
Instance details Defined in Network.AWS.SES.SendBounce type Rep SendBounceResponse = D1 (MetaData "SendBounceResponse" "Network.AWS.SES.SendBounce" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "SendBounceResponse'" PrefixI True) (S1 (MetaSel (Just "_sbrsMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

sbrsMessageId :: Lens' SendBounceResponse (Maybe Text) #

The message ID of the bounce message.

sbrsResponseStatus :: Lens' SendBounceResponse Int #

- | The response status code.