| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.SES.SendBounce
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.
You cannot use this API to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
See: AWS API Reference for SendBounce.
- sendBounce :: Text -> Text -> SendBounce
- data SendBounce
- sbMessageDsn :: Lens' SendBounce (Maybe MessageDsn)
- sbExplanation :: Lens' SendBounce (Maybe Text)
- sbBounceSenderARN :: Lens' SendBounce (Maybe Text)
- sbOriginalMessageId :: Lens' SendBounce Text
- sbBounceSender :: Lens' SendBounce Text
- sbBouncedRecipientInfoList :: Lens' SendBounce [BouncedRecipientInfo]
- sendBounceResponse :: Int -> SendBounceResponse
- data SendBounceResponse
- sbrsMessageId :: Lens' SendBounceResponse (Maybe Text)
- sbrsResponseStatus :: Lens' SendBounceResponse Int
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> 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:
data SendBounce Source
Request object for sending a simple/complex bounce. It contains all of the information needed to generate a basic DSN or a fully-customized DSN.
See: sendBounce smart constructor.
Instances
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
Arguments
| :: Int | |
| -> 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:
data SendBounceResponse Source
See: sendBounceResponse smart constructor.
Response Lenses
sbrsMessageId :: Lens' SendBounceResponse (Maybe Text) Source
The message ID of the bounce message.
sbrsResponseStatus :: Lens' SendBounceResponse Int Source
The response status code.