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

#include <SendEmailRequest.h>

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

Public Member Functions

 SendEmailRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSource () const
 
bool SourceHasBeenSet () const
 
void SetSource (const Aws::String &value)
 
void SetSource (Aws::String &&value)
 
void SetSource (const char *value)
 
SendEmailRequestWithSource (const Aws::String &value)
 
SendEmailRequestWithSource (Aws::String &&value)
 
SendEmailRequestWithSource (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 MessageGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Message &value)
 
void SetMessage (Message &&value)
 
SendEmailRequestWithMessage (const Message &value)
 
SendEmailRequestWithMessage (Message &&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::StringGetReturnPath () const
 
bool ReturnPathHasBeenSet () const
 
void SetReturnPath (const Aws::String &value)
 
void SetReturnPath (Aws::String &&value)
 
void SetReturnPath (const char *value)
 
SendEmailRequestWithReturnPath (const Aws::String &value)
 
SendEmailRequestWithReturnPath (Aws::String &&value)
 
SendEmailRequestWithReturnPath (const char *value)
 
const Aws::StringGetSourceArn () const
 
bool SourceArnHasBeenSet () const
 
void SetSourceArn (const Aws::String &value)
 
void SetSourceArn (Aws::String &&value)
 
void SetSourceArn (const char *value)
 
SendEmailRequestWithSourceArn (const Aws::String &value)
 
SendEmailRequestWithSourceArn (Aws::String &&value)
 
SendEmailRequestWithSourceArn (const char *value)
 
const Aws::StringGetReturnPathArn () const
 
bool ReturnPathArnHasBeenSet () const
 
void SetReturnPathArn (const Aws::String &value)
 
void SetReturnPathArn (Aws::String &&value)
 
void SetReturnPathArn (const char *value)
 
SendEmailRequestWithReturnPathArn (const Aws::String &value)
 
SendEmailRequestWithReturnPathArn (Aws::String &&value)
 
SendEmailRequestWithReturnPathArn (const char *value)
 
const Aws::Vector< MessageTag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< MessageTag > &value)
 
void SetTags (Aws::Vector< MessageTag > &&value)
 
SendEmailRequestWithTags (const Aws::Vector< MessageTag > &value)
 
SendEmailRequestWithTags (Aws::Vector< MessageTag > &&value)
 
SendEmailRequestAddTags (const MessageTag &value)
 
SendEmailRequestAddTags (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::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 single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

AWS API Reference

Definition at line 31 of file SendEmailRequest.h.

Constructor & Destructor Documentation

◆ SendEmailRequest()

Aws::SES::Model::SendEmailRequest::SendEmailRequest ( )

Member Function Documentation

◆ AddReplyToAddresses() [1/3]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 374 of file SendEmailRequest.h.

◆ AddReplyToAddresses() [2/3]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 368 of file SendEmailRequest.h.

◆ AddReplyToAddresses() [3/3]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 380 of file SendEmailRequest.h.

◆ AddTags() [1/2]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::AddTags ( const MessageTag value)
inline

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

Definition at line 785 of file SendEmailRequest.h.

◆ AddTags() [2/2]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::AddTags ( MessageTag &&  value)
inline

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

Definition at line 792 of file SendEmailRequest.h.

◆ ConfigurationSetNameHasBeenSet()

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 805 of file SendEmailRequest.h.

◆ DestinationHasBeenSet()

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

The destination for this email, composed of To:, CC:, and BCC: fields.

Definition at line 274 of file SendEmailRequest.h.

◆ DumpBodyToUrl()

void Aws::SES::Model::SendEmailRequest::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.

◆ GetConfigurationSetName()

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 799 of file SendEmailRequest.h.

◆ GetDestination()

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

The destination for this email, composed of To:, CC:, and BCC: fields.

Definition at line 269 of file SendEmailRequest.h.

◆ GetMessage()

const Message& Aws::SES::Model::SendEmailRequest::GetMessage ( ) const
inline

The message to be sent.

Definition at line 300 of file SendEmailRequest.h.

◆ GetReplyToAddresses()

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 332 of file SendEmailRequest.h.

◆ GetReturnPath()

const Aws::String& Aws::SES::Model::SendEmailRequest::GetReturnPath ( ) const
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 392 of file SendEmailRequest.h.

◆ GetReturnPathArn()

const Aws::String& Aws::SES::Model::SendEmailRequest::GetReturnPathArn ( ) 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 616 of file SendEmailRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file SendEmailRequest.h.

◆ GetSource()

const Aws::String& Aws::SES::Model::SendEmailRequest::GetSource ( ) const
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 74 of file SendEmailRequest.h.

◆ GetSourceArn()

const Aws::String& Aws::SES::Model::SendEmailRequest::GetSourceArn ( ) 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 486 of file SendEmailRequest.h.

◆ GetTags()

const Aws::Vector<MessageTag>& Aws::SES::Model::SendEmailRequest::GetTags ( ) const
inline

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

Definition at line 743 of file SendEmailRequest.h.

◆ MessageHasBeenSet()

bool Aws::SES::Model::SendEmailRequest::MessageHasBeenSet ( ) const
inline

The message to be sent.

Definition at line 305 of file SendEmailRequest.h.

◆ ReplyToAddressesHasBeenSet()

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 338 of file SendEmailRequest.h.

◆ ReturnPathArnHasBeenSet()

bool Aws::SES::Model::SendEmailRequest::ReturnPathArnHasBeenSet ( ) 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 633 of file SendEmailRequest.h.

◆ ReturnPathHasBeenSet()

bool Aws::SES::Model::SendEmailRequest::ReturnPathHasBeenSet ( ) const
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 403 of file SendEmailRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConfigurationSetName() [1/3]

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 817 of file SendEmailRequest.h.

◆ SetConfigurationSetName() [2/3]

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 811 of file SendEmailRequest.h.

◆ SetConfigurationSetName() [3/3]

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 823 of file SendEmailRequest.h.

◆ SetDestination() [1/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields.

Definition at line 279 of file SendEmailRequest.h.

◆ SetDestination() [2/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields.

Definition at line 284 of file SendEmailRequest.h.

◆ SetMessage() [1/2]

void Aws::SES::Model::SendEmailRequest::SetMessage ( const Message value)
inline

The message to be sent.

Definition at line 310 of file SendEmailRequest.h.

◆ SetMessage() [2/2]

void Aws::SES::Model::SendEmailRequest::SetMessage ( Message &&  value)
inline

The message to be sent.

Definition at line 315 of file SendEmailRequest.h.

◆ SetReplyToAddresses() [1/2]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 350 of file SendEmailRequest.h.

◆ SetReplyToAddresses() [2/2]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 344 of file SendEmailRequest.h.

◆ SetReturnPath() [1/3]

void Aws::SES::Model::SendEmailRequest::SetReturnPath ( Aws::String &&  value)
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 425 of file SendEmailRequest.h.

◆ SetReturnPath() [2/3]

void Aws::SES::Model::SendEmailRequest::SetReturnPath ( const Aws::String value)
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 414 of file SendEmailRequest.h.

◆ SetReturnPath() [3/3]

void Aws::SES::Model::SendEmailRequest::SetReturnPath ( const char *  value)
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 436 of file SendEmailRequest.h.

◆ SetReturnPathArn() [1/3]

void Aws::SES::Model::SendEmailRequest::SetReturnPathArn ( 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 667 of file SendEmailRequest.h.

◆ SetReturnPathArn() [2/3]

void Aws::SES::Model::SendEmailRequest::SetReturnPathArn ( 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 650 of file SendEmailRequest.h.

◆ SetReturnPathArn() [3/3]

void Aws::SES::Model::SendEmailRequest::SetReturnPathArn ( 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 684 of file SendEmailRequest.h.

◆ SetSource() [1/3]

void Aws::SES::Model::SendEmailRequest::SetSource ( Aws::String &&  value)
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 155 of file SendEmailRequest.h.

◆ SetSource() [2/3]

void Aws::SES::Model::SendEmailRequest::SetSource ( const Aws::String value)
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 128 of file SendEmailRequest.h.

◆ SetSource() [3/3]

void Aws::SES::Model::SendEmailRequest::SetSource ( const char *  value)
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 182 of file SendEmailRequest.h.

◆ SetSourceArn() [1/3]

void Aws::SES::Model::SendEmailRequest::SetSourceArn ( 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 534 of file SendEmailRequest.h.

◆ SetSourceArn() [2/3]

void Aws::SES::Model::SendEmailRequest::SetSourceArn ( 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 518 of file SendEmailRequest.h.

◆ SetSourceArn() [3/3]

void Aws::SES::Model::SendEmailRequest::SetSourceArn ( 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 550 of file SendEmailRequest.h.

◆ SetTags() [1/2]

void Aws::SES::Model::SendEmailRequest::SetTags ( 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 SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 764 of file SendEmailRequest.h.

◆ SetTags() [2/2]

void Aws::SES::Model::SendEmailRequest::SetTags ( 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 SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 757 of file SendEmailRequest.h.

◆ SourceArnHasBeenSet()

bool Aws::SES::Model::SendEmailRequest::SourceArnHasBeenSet ( ) 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 502 of file SendEmailRequest.h.

◆ SourceHasBeenSet()

bool Aws::SES::Model::SendEmailRequest::SourceHasBeenSet ( ) const
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 101 of file SendEmailRequest.h.

◆ TagsHasBeenSet()

bool Aws::SES::Model::SendEmailRequest::TagsHasBeenSet ( ) const
inline

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

Definition at line 750 of file SendEmailRequest.h.

◆ WithConfigurationSetName() [1/3]

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 835 of file SendEmailRequest.h.

◆ WithConfigurationSetName() [2/3]

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 829 of file SendEmailRequest.h.

◆ WithConfigurationSetName() [3/3]

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

The name of the configuration set to use when you send an email using SendEmail.

Definition at line 841 of file SendEmailRequest.h.

◆ WithDestination() [1/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields.

Definition at line 289 of file SendEmailRequest.h.

◆ WithDestination() [2/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields.

Definition at line 294 of file SendEmailRequest.h.

◆ WithMessage() [1/2]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithMessage ( const Message value)
inline

The message to be sent.

Definition at line 320 of file SendEmailRequest.h.

◆ WithMessage() [2/2]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithMessage ( Message &&  value)
inline

The message to be sent.

Definition at line 325 of file SendEmailRequest.h.

◆ WithReplyToAddresses() [1/2]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 362 of file SendEmailRequest.h.

◆ WithReplyToAddresses() [2/2]

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

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Definition at line 356 of file SendEmailRequest.h.

◆ WithReturnPath() [1/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithReturnPath ( Aws::String &&  value)
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 458 of file SendEmailRequest.h.

◆ WithReturnPath() [2/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithReturnPath ( const Aws::String value)
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 447 of file SendEmailRequest.h.

◆ WithReturnPath() [3/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithReturnPath ( const char *  value)
inline

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Definition at line 469 of file SendEmailRequest.h.

◆ WithReturnPathArn() [1/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithReturnPathArn ( 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 718 of file SendEmailRequest.h.

◆ WithReturnPathArn() [2/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithReturnPathArn ( 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 701 of file SendEmailRequest.h.

◆ WithReturnPathArn() [3/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithReturnPathArn ( 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 email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedb.nosp@m.ack@.nosp@m.examp.nosp@m.le.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 735 of file SendEmailRequest.h.

◆ WithSource() [1/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithSource ( Aws::String &&  value)
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 236 of file SendEmailRequest.h.

◆ WithSource() [2/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithSource ( const Aws::String value)
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 209 of file SendEmailRequest.h.

◆ WithSource() [3/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithSource ( const char *  value)
inline

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 263 of file SendEmailRequest.h.

◆ WithSourceArn() [1/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithSourceArn ( 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 582 of file SendEmailRequest.h.

◆ WithSourceArn() [2/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithSourceArn ( 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 566 of file SendEmailRequest.h.

◆ WithSourceArn() [3/3]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithSourceArn ( 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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

For more information about sending authorization, see the Amazon SES Developer Guide.

Definition at line 598 of file SendEmailRequest.h.

◆ WithTags() [1/2]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithTags ( 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 SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 778 of file SendEmailRequest.h.

◆ WithTags() [2/2]

SendEmailRequest& Aws::SES::Model::SendEmailRequest::WithTags ( 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 SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Definition at line 771 of file SendEmailRequest.h.


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