AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SES::Model::SendBounceRequest Class Reference

#include <SendBounceRequest.h>

+ Inheritance diagram for Aws::SES::Model::SendBounceRequest:

Public Member Functions

 SendBounceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetOriginalMessageId () const
 
bool OriginalMessageIdHasBeenSet () const
 
void SetOriginalMessageId (const Aws::String &value)
 
void SetOriginalMessageId (Aws::String &&value)
 
void SetOriginalMessageId (const char *value)
 
SendBounceRequestWithOriginalMessageId (const Aws::String &value)
 
SendBounceRequestWithOriginalMessageId (Aws::String &&value)
 
SendBounceRequestWithOriginalMessageId (const char *value)
 
const Aws::StringGetBounceSender () const
 
bool BounceSenderHasBeenSet () const
 
void SetBounceSender (const Aws::String &value)
 
void SetBounceSender (Aws::String &&value)
 
void SetBounceSender (const char *value)
 
SendBounceRequestWithBounceSender (const Aws::String &value)
 
SendBounceRequestWithBounceSender (Aws::String &&value)
 
SendBounceRequestWithBounceSender (const char *value)
 
const Aws::StringGetExplanation () const
 
bool ExplanationHasBeenSet () const
 
void SetExplanation (const Aws::String &value)
 
void SetExplanation (Aws::String &&value)
 
void SetExplanation (const char *value)
 
SendBounceRequestWithExplanation (const Aws::String &value)
 
SendBounceRequestWithExplanation (Aws::String &&value)
 
SendBounceRequestWithExplanation (const char *value)
 
const MessageDsnGetMessageDsn () const
 
bool MessageDsnHasBeenSet () const
 
void SetMessageDsn (const MessageDsn &value)
 
void SetMessageDsn (MessageDsn &&value)
 
SendBounceRequestWithMessageDsn (const MessageDsn &value)
 
SendBounceRequestWithMessageDsn (MessageDsn &&value)
 
const Aws::Vector< BouncedRecipientInfo > & GetBouncedRecipientInfoList () const
 
bool BouncedRecipientInfoListHasBeenSet () const
 
void SetBouncedRecipientInfoList (const Aws::Vector< BouncedRecipientInfo > &value)
 
void SetBouncedRecipientInfoList (Aws::Vector< BouncedRecipientInfo > &&value)
 
SendBounceRequestWithBouncedRecipientInfoList (const Aws::Vector< BouncedRecipientInfo > &value)
 
SendBounceRequestWithBouncedRecipientInfoList (Aws::Vector< BouncedRecipientInfo > &&value)
 
SendBounceRequestAddBouncedRecipientInfoList (const BouncedRecipientInfo &value)
 
SendBounceRequestAddBouncedRecipientInfoList (BouncedRecipientInfo &&value)
 
const Aws::StringGetBounceSenderArn () const
 
bool BounceSenderArnHasBeenSet () const
 
void SetBounceSenderArn (const Aws::String &value)
 
void SetBounceSenderArn (Aws::String &&value)
 
void SetBounceSenderArn (const char *value)
 
SendBounceRequestWithBounceSenderArn (const Aws::String &value)
 
SendBounceRequestWithBounceSenderArn (Aws::String &&value)
 
SendBounceRequestWithBounceSenderArn (const char *value)
 
- Public Member Functions inherited from Aws::SES::SESRequest
virtual ~SESRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SES::SESRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 28 of file SendBounceRequest.h.

Constructor & Destructor Documentation

◆ SendBounceRequest()

Aws::SES::Model::SendBounceRequest::SendBounceRequest ( )

Member Function Documentation

◆ AddBouncedRecipientInfoList() [1/2]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::AddBouncedRecipientInfoList ( const BouncedRecipientInfo value)
inline

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.

Definition at line 277 of file SendBounceRequest.h.

◆ AddBouncedRecipientInfoList() [2/2]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::AddBouncedRecipientInfoList ( BouncedRecipientInfo &&  value)
inline

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.

Definition at line 284 of file SendBounceRequest.h.

◆ BouncedRecipientInfoListHasBeenSet()

bool Aws::SES::Model::SendBounceRequest::BouncedRecipientInfoListHasBeenSet ( ) const
inline

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.

Definition at line 242 of file SendBounceRequest.h.

◆ BounceSenderArnHasBeenSet()

bool Aws::SES::Model::SendBounceRequest::BounceSenderArnHasBeenSet ( ) const
inline

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.

Definition at line 305 of file SendBounceRequest.h.

◆ BounceSenderHasBeenSet()

bool Aws::SES::Model::SendBounceRequest::BounceSenderHasBeenSet ( ) const
inline

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

Definition at line 97 of file SendBounceRequest.h.

◆ DumpBodyToUrl()

void Aws::SES::Model::SendBounceRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExplanationHasBeenSet()

bool Aws::SES::Model::SendBounceRequest::ExplanationHasBeenSet ( ) const
inline

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.

Definition at line 148 of file SendBounceRequest.h.

◆ GetBouncedRecipientInfoList()

const Aws::Vector<BouncedRecipientInfo>& Aws::SES::Model::SendBounceRequest::GetBouncedRecipientInfoList ( ) const
inline

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.

Definition at line 235 of file SendBounceRequest.h.

◆ GetBounceSender()

const Aws::String& Aws::SES::Model::SendBounceRequest::GetBounceSender ( ) const
inline

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

Definition at line 91 of file SendBounceRequest.h.

◆ GetBounceSenderArn()

const Aws::String& Aws::SES::Model::SendBounceRequest::GetBounceSenderArn ( ) const
inline

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.

Definition at line 295 of file SendBounceRequest.h.

◆ GetExplanation()

const Aws::String& Aws::SES::Model::SendBounceRequest::GetExplanation ( ) const
inline

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.

Definition at line 141 of file SendBounceRequest.h.

◆ GetMessageDsn()

const MessageDsn& Aws::SES::Model::SendBounceRequest::GetMessageDsn ( ) const
inline

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

Definition at line 197 of file SendBounceRequest.h.

◆ GetOriginalMessageId()

const Aws::String& Aws::SES::Model::SendBounceRequest::GetOriginalMessageId ( ) const
inline

The message ID of the message to be bounced.

Definition at line 49 of file SendBounceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SES::Model::SendBounceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file SendBounceRequest.h.

◆ MessageDsnHasBeenSet()

bool Aws::SES::Model::SendBounceRequest::MessageDsnHasBeenSet ( ) const
inline

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

Definition at line 203 of file SendBounceRequest.h.

◆ OriginalMessageIdHasBeenSet()

bool Aws::SES::Model::SendBounceRequest::OriginalMessageIdHasBeenSet ( ) const
inline

The message ID of the message to be bounced.

Definition at line 54 of file SendBounceRequest.h.

◆ SerializePayload()

Aws::String Aws::SES::Model::SendBounceRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBouncedRecipientInfoList() [1/2]

void Aws::SES::Model::SendBounceRequest::SetBouncedRecipientInfoList ( const Aws::Vector< BouncedRecipientInfo > &  value)
inline

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.

Definition at line 249 of file SendBounceRequest.h.

◆ SetBouncedRecipientInfoList() [2/2]

void Aws::SES::Model::SendBounceRequest::SetBouncedRecipientInfoList ( Aws::Vector< BouncedRecipientInfo > &&  value)
inline

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.

Definition at line 256 of file SendBounceRequest.h.

◆ SetBounceSender() [1/3]

void Aws::SES::Model::SendBounceRequest::SetBounceSender ( const Aws::String value)
inline

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

Definition at line 103 of file SendBounceRequest.h.

◆ SetBounceSender() [2/3]

void Aws::SES::Model::SendBounceRequest::SetBounceSender ( Aws::String &&  value)
inline

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

Definition at line 109 of file SendBounceRequest.h.

◆ SetBounceSender() [3/3]

void Aws::SES::Model::SendBounceRequest::SetBounceSender ( const char *  value)
inline

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

Definition at line 115 of file SendBounceRequest.h.

◆ SetBounceSenderArn() [1/3]

void Aws::SES::Model::SendBounceRequest::SetBounceSenderArn ( const Aws::String value)
inline

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.

Definition at line 315 of file SendBounceRequest.h.

◆ SetBounceSenderArn() [2/3]

void Aws::SES::Model::SendBounceRequest::SetBounceSenderArn ( Aws::String &&  value)
inline

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.

Definition at line 325 of file SendBounceRequest.h.

◆ SetBounceSenderArn() [3/3]

void Aws::SES::Model::SendBounceRequest::SetBounceSenderArn ( const char *  value)
inline

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.

Definition at line 335 of file SendBounceRequest.h.

◆ SetExplanation() [1/3]

void Aws::SES::Model::SendBounceRequest::SetExplanation ( const Aws::String value)
inline

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.

Definition at line 155 of file SendBounceRequest.h.

◆ SetExplanation() [2/3]

void Aws::SES::Model::SendBounceRequest::SetExplanation ( Aws::String &&  value)
inline

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.

Definition at line 162 of file SendBounceRequest.h.

◆ SetExplanation() [3/3]

void Aws::SES::Model::SendBounceRequest::SetExplanation ( const char *  value)
inline

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.

Definition at line 169 of file SendBounceRequest.h.

◆ SetMessageDsn() [1/2]

void Aws::SES::Model::SendBounceRequest::SetMessageDsn ( const MessageDsn value)
inline

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

Definition at line 209 of file SendBounceRequest.h.

◆ SetMessageDsn() [2/2]

void Aws::SES::Model::SendBounceRequest::SetMessageDsn ( MessageDsn &&  value)
inline

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

Definition at line 215 of file SendBounceRequest.h.

◆ SetOriginalMessageId() [1/3]

void Aws::SES::Model::SendBounceRequest::SetOriginalMessageId ( const Aws::String value)
inline

The message ID of the message to be bounced.

Definition at line 59 of file SendBounceRequest.h.

◆ SetOriginalMessageId() [2/3]

void Aws::SES::Model::SendBounceRequest::SetOriginalMessageId ( Aws::String &&  value)
inline

The message ID of the message to be bounced.

Definition at line 64 of file SendBounceRequest.h.

◆ SetOriginalMessageId() [3/3]

void Aws::SES::Model::SendBounceRequest::SetOriginalMessageId ( const char *  value)
inline

The message ID of the message to be bounced.

Definition at line 69 of file SendBounceRequest.h.

◆ WithBouncedRecipientInfoList() [1/2]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBouncedRecipientInfoList ( const Aws::Vector< BouncedRecipientInfo > &  value)
inline

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.

Definition at line 263 of file SendBounceRequest.h.

◆ WithBouncedRecipientInfoList() [2/2]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBouncedRecipientInfoList ( Aws::Vector< BouncedRecipientInfo > &&  value)
inline

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.

Definition at line 270 of file SendBounceRequest.h.

◆ WithBounceSender() [1/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBounceSender ( const Aws::String value)
inline

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

Definition at line 121 of file SendBounceRequest.h.

◆ WithBounceSender() [2/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBounceSender ( Aws::String &&  value)
inline

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

Definition at line 127 of file SendBounceRequest.h.

◆ WithBounceSender() [3/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBounceSender ( const char *  value)
inline

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

Definition at line 133 of file SendBounceRequest.h.

◆ WithBounceSenderArn() [1/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBounceSenderArn ( const Aws::String value)
inline

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.

Definition at line 345 of file SendBounceRequest.h.

◆ WithBounceSenderArn() [2/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBounceSenderArn ( Aws::String &&  value)
inline

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.

Definition at line 355 of file SendBounceRequest.h.

◆ WithBounceSenderArn() [3/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithBounceSenderArn ( const char *  value)
inline

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.

Definition at line 365 of file SendBounceRequest.h.

◆ WithExplanation() [1/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithExplanation ( const Aws::String value)
inline

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.

Definition at line 176 of file SendBounceRequest.h.

◆ WithExplanation() [2/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithExplanation ( Aws::String &&  value)
inline

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.

Definition at line 183 of file SendBounceRequest.h.

◆ WithExplanation() [3/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithExplanation ( const char *  value)
inline

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.

Definition at line 190 of file SendBounceRequest.h.

◆ WithMessageDsn() [1/2]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithMessageDsn ( const MessageDsn value)
inline

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

Definition at line 221 of file SendBounceRequest.h.

◆ WithMessageDsn() [2/2]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithMessageDsn ( MessageDsn &&  value)
inline

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

Definition at line 227 of file SendBounceRequest.h.

◆ WithOriginalMessageId() [1/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithOriginalMessageId ( const Aws::String value)
inline

The message ID of the message to be bounced.

Definition at line 74 of file SendBounceRequest.h.

◆ WithOriginalMessageId() [2/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithOriginalMessageId ( Aws::String &&  value)
inline

The message ID of the message to be bounced.

Definition at line 79 of file SendBounceRequest.h.

◆ WithOriginalMessageId() [3/3]

SendBounceRequest& Aws::SES::Model::SendBounceRequest::WithOriginalMessageId ( const char *  value)
inline

The message ID of the message to be bounced.

Definition at line 84 of file SendBounceRequest.h.


The documentation for this class was generated from the following file: