AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::PinpointEmail::Model::SendEmailRequest Class Reference

#include <SendEmailRequest.h>

+ Inheritance diagram for Aws::PinpointEmail::Model::SendEmailRequest:

Public Member Functions

 SendEmailRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetFromEmailAddress () const
 
bool FromEmailAddressHasBeenSet () const
 
void SetFromEmailAddress (const Aws::String &value)
 
void SetFromEmailAddress (Aws::String &&value)
 
void SetFromEmailAddress (const char *value)
 
SendEmailRequestWithFromEmailAddress (const Aws::String &value)
 
SendEmailRequestWithFromEmailAddress (Aws::String &&value)
 
SendEmailRequestWithFromEmailAddress (const char *value)
 
const DestinationGetDestination () const
 
bool DestinationHasBeenSet () const
 
void SetDestination (const Destination &value)
 
void SetDestination (Destination &&value)
 
SendEmailRequestWithDestination (const Destination &value)
 
SendEmailRequestWithDestination (Destination &&value)
 
const Aws::Vector< Aws::String > & GetReplyToAddresses () const
 
bool ReplyToAddressesHasBeenSet () const
 
void SetReplyToAddresses (const Aws::Vector< Aws::String > &value)
 
void SetReplyToAddresses (Aws::Vector< Aws::String > &&value)
 
SendEmailRequestWithReplyToAddresses (const Aws::Vector< Aws::String > &value)
 
SendEmailRequestWithReplyToAddresses (Aws::Vector< Aws::String > &&value)
 
SendEmailRequestAddReplyToAddresses (const Aws::String &value)
 
SendEmailRequestAddReplyToAddresses (Aws::String &&value)
 
SendEmailRequestAddReplyToAddresses (const char *value)
 
const Aws::StringGetFeedbackForwardingEmailAddress () const
 
bool FeedbackForwardingEmailAddressHasBeenSet () const
 
void SetFeedbackForwardingEmailAddress (const Aws::String &value)
 
void SetFeedbackForwardingEmailAddress (Aws::String &&value)
 
void SetFeedbackForwardingEmailAddress (const char *value)
 
SendEmailRequestWithFeedbackForwardingEmailAddress (const Aws::String &value)
 
SendEmailRequestWithFeedbackForwardingEmailAddress (Aws::String &&value)
 
SendEmailRequestWithFeedbackForwardingEmailAddress (const char *value)
 
const EmailContentGetContent () const
 
bool ContentHasBeenSet () const
 
void SetContent (const EmailContent &value)
 
void SetContent (EmailContent &&value)
 
SendEmailRequestWithContent (const EmailContent &value)
 
SendEmailRequestWithContent (EmailContent &&value)
 
const Aws::Vector< MessageTag > & GetEmailTags () const
 
bool EmailTagsHasBeenSet () const
 
void SetEmailTags (const Aws::Vector< MessageTag > &value)
 
void SetEmailTags (Aws::Vector< MessageTag > &&value)
 
SendEmailRequestWithEmailTags (const Aws::Vector< MessageTag > &value)
 
SendEmailRequestWithEmailTags (Aws::Vector< MessageTag > &&value)
 
SendEmailRequestAddEmailTags (const MessageTag &value)
 
SendEmailRequestAddEmailTags (MessageTag &&value)
 
const Aws::StringGetConfigurationSetName () const
 
bool ConfigurationSetNameHasBeenSet () const
 
void SetConfigurationSetName (const Aws::String &value)
 
void SetConfigurationSetName (Aws::String &&value)
 
void SetConfigurationSetName (const char *value)
 
SendEmailRequestWithConfigurationSetName (const Aws::String &value)
 
SendEmailRequestWithConfigurationSetName (Aws::String &&value)
 
SendEmailRequestWithConfigurationSetName (const char *value)
 
- Public Member Functions inherited from Aws::PinpointEmail::PinpointEmailRequest
virtual ~PinpointEmailRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::PinpointEmail::PinpointEmailRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

A request to send an email message.

See Also:

AWS API Reference

Definition at line 28 of file SendEmailRequest.h.

Constructor & Destructor Documentation

◆ SendEmailRequest()

Aws::PinpointEmail::Model::SendEmailRequest::SendEmailRequest ( )

Member Function Documentation

◆ AddEmailTags() [1/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::AddEmailTags ( const MessageTag value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 317 of file SendEmailRequest.h.

◆ AddEmailTags() [2/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::AddEmailTags ( MessageTag &&  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 325 of file SendEmailRequest.h.

◆ AddReplyToAddresses() [1/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::AddReplyToAddresses ( const Aws::String value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 162 of file SendEmailRequest.h.

◆ AddReplyToAddresses() [2/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::AddReplyToAddresses ( Aws::String &&  value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 168 of file SendEmailRequest.h.

◆ AddReplyToAddresses() [3/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::AddReplyToAddresses ( const char *  value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 174 of file SendEmailRequest.h.

◆ ConfigurationSetNameHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::ConfigurationSetNameHasBeenSet ( ) const
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 338 of file SendEmailRequest.h.

◆ ContentHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::ContentHasBeenSet ( ) const
inline

An object that contains the body of the message. You can send either a Simple message or a Raw message.

Definition at line 236 of file SendEmailRequest.h.

◆ DestinationHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::DestinationHasBeenSet ( ) const
inline

An object that contains the recipients of the email message.

Definition at line 99 of file SendEmailRequest.h.

◆ EmailTagsHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::EmailTagsHasBeenSet ( ) const
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 277 of file SendEmailRequest.h.

◆ FeedbackForwardingEmailAddressHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::FeedbackForwardingEmailAddressHasBeenSet ( ) const
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 187 of file SendEmailRequest.h.

◆ FromEmailAddressHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::FromEmailAddressHasBeenSet ( ) const
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 52 of file SendEmailRequest.h.

◆ GetConfigurationSetName()

const Aws::String& Aws::PinpointEmail::Model::SendEmailRequest::GetConfigurationSetName ( ) const
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 332 of file SendEmailRequest.h.

◆ GetContent()

const EmailContent& Aws::PinpointEmail::Model::SendEmailRequest::GetContent ( ) const
inline

An object that contains the body of the message. You can send either a Simple message or a Raw message.

Definition at line 230 of file SendEmailRequest.h.

◆ GetDestination()

const Destination& Aws::PinpointEmail::Model::SendEmailRequest::GetDestination ( ) const
inline

An object that contains the recipients of the email message.

Definition at line 94 of file SendEmailRequest.h.

◆ GetEmailTags()

const Aws::Vector<MessageTag>& Aws::PinpointEmail::Model::SendEmailRequest::GetEmailTags ( ) const
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 269 of file SendEmailRequest.h.

◆ GetFeedbackForwardingEmailAddress()

const Aws::String& Aws::PinpointEmail::Model::SendEmailRequest::GetFeedbackForwardingEmailAddress ( ) const
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 181 of file SendEmailRequest.h.

◆ GetFromEmailAddress()

const Aws::String& Aws::PinpointEmail::Model::SendEmailRequest::GetFromEmailAddress ( ) const
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 46 of file SendEmailRequest.h.

◆ GetReplyToAddresses()

const Aws::Vector<Aws::String>& Aws::PinpointEmail::Model::SendEmailRequest::GetReplyToAddresses ( ) const
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 126 of file SendEmailRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::PinpointEmail::Model::SendEmailRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file SendEmailRequest.h.

◆ ReplyToAddressesHasBeenSet()

bool Aws::PinpointEmail::Model::SendEmailRequest::ReplyToAddressesHasBeenSet ( ) const
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 132 of file SendEmailRequest.h.

◆ SerializePayload()

Aws::String Aws::PinpointEmail::Model::SendEmailRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConfigurationSetName() [1/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetConfigurationSetName ( const Aws::String value)
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 344 of file SendEmailRequest.h.

◆ SetConfigurationSetName() [2/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetConfigurationSetName ( Aws::String &&  value)
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 350 of file SendEmailRequest.h.

◆ SetConfigurationSetName() [3/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetConfigurationSetName ( const char *  value)
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 356 of file SendEmailRequest.h.

◆ SetContent() [1/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetContent ( const EmailContent value)
inline

An object that contains the body of the message. You can send either a Simple message or a Raw message.

Definition at line 242 of file SendEmailRequest.h.

◆ SetContent() [2/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetContent ( EmailContent &&  value)
inline

An object that contains the body of the message. You can send either a Simple message or a Raw message.

Definition at line 248 of file SendEmailRequest.h.

◆ SetDestination() [1/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetDestination ( const Destination value)
inline

An object that contains the recipients of the email message.

Definition at line 104 of file SendEmailRequest.h.

◆ SetDestination() [2/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetDestination ( Destination &&  value)
inline

An object that contains the recipients of the email message.

Definition at line 109 of file SendEmailRequest.h.

◆ SetEmailTags() [1/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetEmailTags ( const Aws::Vector< MessageTag > &  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 285 of file SendEmailRequest.h.

◆ SetEmailTags() [2/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetEmailTags ( Aws::Vector< MessageTag > &&  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 293 of file SendEmailRequest.h.

◆ SetFeedbackForwardingEmailAddress() [1/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetFeedbackForwardingEmailAddress ( const Aws::String value)
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 193 of file SendEmailRequest.h.

◆ SetFeedbackForwardingEmailAddress() [2/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetFeedbackForwardingEmailAddress ( Aws::String &&  value)
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 199 of file SendEmailRequest.h.

◆ SetFeedbackForwardingEmailAddress() [3/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetFeedbackForwardingEmailAddress ( const char *  value)
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 205 of file SendEmailRequest.h.

◆ SetFromEmailAddress() [1/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetFromEmailAddress ( const Aws::String value)
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 58 of file SendEmailRequest.h.

◆ SetFromEmailAddress() [2/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetFromEmailAddress ( Aws::String &&  value)
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 64 of file SendEmailRequest.h.

◆ SetFromEmailAddress() [3/3]

void Aws::PinpointEmail::Model::SendEmailRequest::SetFromEmailAddress ( const char *  value)
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 70 of file SendEmailRequest.h.

◆ SetReplyToAddresses() [1/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetReplyToAddresses ( const Aws::Vector< Aws::String > &  value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 138 of file SendEmailRequest.h.

◆ SetReplyToAddresses() [2/2]

void Aws::PinpointEmail::Model::SendEmailRequest::SetReplyToAddresses ( Aws::Vector< Aws::String > &&  value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 144 of file SendEmailRequest.h.

◆ WithConfigurationSetName() [1/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithConfigurationSetName ( const Aws::String value)
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 362 of file SendEmailRequest.h.

◆ WithConfigurationSetName() [2/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithConfigurationSetName ( Aws::String &&  value)
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 368 of file SendEmailRequest.h.

◆ WithConfigurationSetName() [3/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithConfigurationSetName ( const char *  value)
inline

The name of the configuration set that you want to use when sending the email.

Definition at line 374 of file SendEmailRequest.h.

◆ WithContent() [1/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithContent ( const EmailContent value)
inline

An object that contains the body of the message. You can send either a Simple message or a Raw message.

Definition at line 254 of file SendEmailRequest.h.

◆ WithContent() [2/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithContent ( EmailContent &&  value)
inline

An object that contains the body of the message. You can send either a Simple message or a Raw message.

Definition at line 260 of file SendEmailRequest.h.

◆ WithDestination() [1/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithDestination ( const Destination value)
inline

An object that contains the recipients of the email message.

Definition at line 114 of file SendEmailRequest.h.

◆ WithDestination() [2/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithDestination ( Destination &&  value)
inline

An object that contains the recipients of the email message.

Definition at line 119 of file SendEmailRequest.h.

◆ WithEmailTags() [1/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithEmailTags ( const Aws::Vector< MessageTag > &  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 301 of file SendEmailRequest.h.

◆ WithEmailTags() [2/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithEmailTags ( Aws::Vector< MessageTag > &&  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 309 of file SendEmailRequest.h.

◆ WithFeedbackForwardingEmailAddress() [1/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithFeedbackForwardingEmailAddress ( const Aws::String value)
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 211 of file SendEmailRequest.h.

◆ WithFeedbackForwardingEmailAddress() [2/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithFeedbackForwardingEmailAddress ( Aws::String &&  value)
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 217 of file SendEmailRequest.h.

◆ WithFeedbackForwardingEmailAddress() [3/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithFeedbackForwardingEmailAddress ( const char *  value)
inline

The address that Amazon Pinpoint should send bounce and complaint notifications to.

Definition at line 223 of file SendEmailRequest.h.

◆ WithFromEmailAddress() [1/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithFromEmailAddress ( const Aws::String value)
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 76 of file SendEmailRequest.h.

◆ WithFromEmailAddress() [2/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithFromEmailAddress ( Aws::String &&  value)
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 82 of file SendEmailRequest.h.

◆ WithFromEmailAddress() [3/3]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithFromEmailAddress ( const char *  value)
inline

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Definition at line 88 of file SendEmailRequest.h.

◆ WithReplyToAddresses() [1/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithReplyToAddresses ( const Aws::Vector< Aws::String > &  value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 150 of file SendEmailRequest.h.

◆ WithReplyToAddresses() [2/2]

SendEmailRequest& Aws::PinpointEmail::Model::SendEmailRequest::WithReplyToAddresses ( Aws::Vector< Aws::String > &&  value)
inline

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Definition at line 156 of file SendEmailRequest.h.


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