amazonka-ses-1.4.5: Amazon Simple Email Service SDK.

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

Network.AWS.SES.SendBounce

Contents

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 .

This action is throttled at one request per second.

Synopsis

Creating a Request

sendBounce Source #

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 Source #

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 Source # 
Data SendBounce Source # 

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 Source # 
Show SendBounce Source # 
Generic SendBounce Source # 

Associated Types

type Rep SendBounce :: * -> * #

Hashable SendBounce Source # 
NFData SendBounce Source # 

Methods

rnf :: SendBounce -> () #

AWSRequest SendBounce Source # 
ToPath SendBounce Source # 
ToHeaders SendBounce Source # 

Methods

toHeaders :: SendBounce -> [Header] #

ToQuery SendBounce Source # 
type Rep SendBounce Source # 
type Rep SendBounce = D1 (MetaData "SendBounce" "Network.AWS.SES.SendBounce" "amazonka-ses-1.4.5-DhIaquVYmXCGGNLt54jVqA" False) (C1 (MetaCons "SendBounce'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sbMessageDsn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MessageDsn))) ((:*:) (S1 (MetaSel (Just Symbol "_sbExplanation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sbBounceSenderARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_sbOriginalMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_sbBounceSender") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sbBouncedRecipientInfoList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [BouncedRecipientInfo]))))))
type Rs SendBounce Source # 

Request Lenses

sbMessageDsn :: Lens' SendBounce (Maybe MessageDsn) Source #

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

sbExplanation :: Lens' SendBounce (Maybe Text) Source #

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) Source #

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 Source #

The message ID of the message to be bounced.

sbBounceSender :: Lens' SendBounce Text Source #

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] Source #

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 Source #

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:

data SendBounceResponse Source #

Represents a unique message ID.

See: sendBounceResponse smart constructor.

Instances

Eq SendBounceResponse Source # 
Data SendBounceResponse Source # 

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 Source # 
Show SendBounceResponse Source # 
Generic SendBounceResponse Source # 
NFData SendBounceResponse Source # 

Methods

rnf :: SendBounceResponse -> () #

type Rep SendBounceResponse Source # 
type Rep SendBounceResponse = D1 (MetaData "SendBounceResponse" "Network.AWS.SES.SendBounce" "amazonka-ses-1.4.5-DhIaquVYmXCGGNLt54jVqA" False) (C1 (MetaCons "SendBounceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sbrsMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

sbrsMessageId :: Lens' SendBounceResponse (Maybe Text) Source #

The message ID of the bounce message.

sbrsResponseStatus :: Lens' SendBounceResponse Int Source #

  • - | The response status code.