Copyright	(c) 2013-2021 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

Amazonka.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.

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.

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

Synopsis

data SendBounce = SendBounce' {
- messageDsn :: Maybe MessageDsn
- explanation :: Maybe Text
- bounceSenderArn :: Maybe Text
- originalMessageId :: Text
- bounceSender :: Text
- bouncedRecipientInfoList :: [BouncedRecipientInfo]
}
newSendBounce :: Text -> Text -> SendBounce
sendBounce_messageDsn :: Lens' SendBounce (Maybe MessageDsn)
sendBounce_explanation :: Lens' SendBounce (Maybe Text)
sendBounce_bounceSenderArn :: Lens' SendBounce (Maybe Text)
sendBounce_originalMessageId :: Lens' SendBounce Text
sendBounce_bounceSender :: Lens' SendBounce Text
sendBounce_bouncedRecipientInfoList :: Lens' SendBounce [BouncedRecipientInfo]
data SendBounceResponse = SendBounceResponse' {
- messageId :: Maybe Text
- httpStatus :: Int
}
newSendBounceResponse :: Int -> SendBounceResponse
sendBounceResponse_messageId :: Lens' SendBounceResponse (Maybe Text)
sendBounceResponse_httpStatus :: Lens' SendBounceResponse Int

Creating a Request

data SendBounce Source #

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

See: newSendBounce smart constructor.

Constructors

SendBounce'

Fields

messageDsn :: Maybe MessageDsn
Message-related DSN fields. If not specified, Amazon SES will choose the values.
explanation :: 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.
bounceSenderArn :: 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.
originalMessageId :: Text
The message ID of the message to be bounced.
bounceSender :: 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.
bouncedRecipientInfoList :: [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.

Instances

Instances details

Eq SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods (==) :: SendBounce -> SendBounce -> Bool # (/=) :: SendBounce -> SendBounce -> Bool #
Read SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods readsPrec :: Int -> ReadS SendBounce # readList :: ReadS [SendBounce] # readPrec :: ReadPrec SendBounce # readListPrec :: ReadPrec [SendBounce] #
Show SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods showsPrec :: Int -> SendBounce -> ShowS # show :: SendBounce -> String # showList :: [SendBounce] -> ShowS #
Generic SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Associated Types type Rep SendBounce :: Type -> Type # Methods from :: SendBounce -> Rep SendBounce x # to :: Rep SendBounce x -> SendBounce #
NFData SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods rnf :: SendBounce -> () #
Hashable SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods hashWithSalt :: Int -> SendBounce -> Int # hash :: SendBounce -> Int #
AWSRequest SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Associated Types type AWSResponse SendBounce # Methods request :: SendBounce -> Request SendBounce # response :: MonadResource m => Logger -> Service -> Proxy SendBounce -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendBounce))) #
ToHeaders SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods toHeaders :: SendBounce -> [Header] #
ToPath SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods toPath :: SendBounce -> ByteString #
ToQuery SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce Methods toQuery :: SendBounce -> QueryString #
type Rep SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce type Rep SendBounce = D1 ('MetaData "SendBounce" "Amazonka.SES.SendBounce" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendBounce'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageDsn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageDsn)) :: (S1 ('MetaSel ('Just "explanation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "bounceSenderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "originalMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "bounceSender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bouncedRecipientInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BouncedRecipientInfo])))))
type AWSResponse SendBounce Source #
Instance details Defined in Amazonka.SES.SendBounce type AWSResponse SendBounce = SendBounceResponse

newSendBounce Source #

Arguments

:: Text	`$sel:originalMessageId:SendBounce'`
-> Text	`$sel:bounceSender:SendBounce'`
-> SendBounce

Create a value of SendBounce 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:messageDsn:SendBounce', sendBounce_messageDsn - Message-related DSN fields. If not specified, Amazon SES will choose the values.

$sel:explanation:SendBounce', sendBounce_explanation - 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.

$sel:bounceSenderArn:SendBounce', sendBounce_bounceSenderArn - 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.

$sel:originalMessageId:SendBounce', sendBounce_originalMessageId - The message ID of the message to be bounced.

$sel:bounceSender:SendBounce', sendBounce_bounceSender - The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

$sel:bouncedRecipientInfoList:SendBounce', sendBounce_bouncedRecipientInfoList - 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.

Request Lenses

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

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

sendBounce_explanation :: 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.

sendBounce_bounceSenderArn :: 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.

sendBounce_originalMessageId :: Lens' SendBounce Text Source #

The message ID of the message to be bounced.

sendBounce_bounceSender :: 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.

sendBounce_bouncedRecipientInfoList :: 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

data SendBounceResponse Source #

Represents a unique message ID.

See: newSendBounceResponse smart constructor.

Constructors

SendBounceResponse'
Fields messageId :: Maybe Text The message ID of the bounce message. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendBounceResponse Source #
Instance details Defined in Amazonka.SES.SendBounce Methods (==) :: SendBounceResponse -> SendBounceResponse -> Bool # (/=) :: SendBounceResponse -> SendBounceResponse -> Bool #
Read SendBounceResponse Source #
Instance details Defined in Amazonka.SES.SendBounce Methods readsPrec :: Int -> ReadS SendBounceResponse # readList :: ReadS [SendBounceResponse] # readPrec :: ReadPrec SendBounceResponse # readListPrec :: ReadPrec [SendBounceResponse] #
Show SendBounceResponse Source #
Instance details Defined in Amazonka.SES.SendBounce Methods showsPrec :: Int -> SendBounceResponse -> ShowS # show :: SendBounceResponse -> String # showList :: [SendBounceResponse] -> ShowS #
Generic SendBounceResponse Source #
Instance details Defined in Amazonka.SES.SendBounce Associated Types type Rep SendBounceResponse :: Type -> Type # Methods from :: SendBounceResponse -> Rep SendBounceResponse x # to :: Rep SendBounceResponse x -> SendBounceResponse #
NFData SendBounceResponse Source #
Instance details Defined in Amazonka.SES.SendBounce Methods rnf :: SendBounceResponse -> () #
type Rep SendBounceResponse Source #
Instance details Defined in Amazonka.SES.SendBounce type Rep SendBounceResponse = D1 ('MetaData "SendBounceResponse" "Amazonka.SES.SendBounce" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendBounceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendBounceResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendBounceResponse'`
-> SendBounceResponse

Create a value of SendBounceResponse 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:messageId:SendBounceResponse', sendBounceResponse_messageId - The message ID of the bounce message.

$sel:httpStatus:SendBounceResponse', sendBounceResponse_httpStatus - The response's http status code.

Response Lenses

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

The message ID of the bounce message.

sendBounceResponse_httpStatus :: Lens' SendBounceResponse Int Source #

The response's http status code.