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

#include <SendTemplatedEmailRequest.h>

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

Public Member Functions

 SendTemplatedEmailRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::String & GetSource () const
 
bool SourceHasBeenSet () const
 
void SetSource (const Aws::String &value)
 
void SetSource (Aws::String &&value)
 
void SetSource (const char *value)
 
SendTemplatedEmailRequest & WithSource (const Aws::String &value)
 
SendTemplatedEmailRequest & WithSource (Aws::String &&value)
 
SendTemplatedEmailRequest & WithSource (const char *value)
 
const Destination & GetDestination () const
 
bool DestinationHasBeenSet () const
 
void SetDestination (const Destination &value)
 
void SetDestination (Destination &&value)
 
SendTemplatedEmailRequest & WithDestination (const Destination &value)
 
SendTemplatedEmailRequest & WithDestination (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)
 
SendTemplatedEmailRequest & WithReplyToAddresses (const Aws::Vector< Aws::String > &value)
 
SendTemplatedEmailRequest & WithReplyToAddresses (Aws::Vector< Aws::String > &&value)
 
SendTemplatedEmailRequest & AddReplyToAddresses (const Aws::String &value)
 
SendTemplatedEmailRequest & AddReplyToAddresses (Aws::String &&value)
 
SendTemplatedEmailRequest & AddReplyToAddresses (const char *value)
 
const Aws::String & GetReturnPath () const
 
bool ReturnPathHasBeenSet () const
 
void SetReturnPath (const Aws::String &value)
 
void SetReturnPath (Aws::String &&value)
 
void SetReturnPath (const char *value)
 
SendTemplatedEmailRequest & WithReturnPath (const Aws::String &value)
 
SendTemplatedEmailRequest & WithReturnPath (Aws::String &&value)
 
SendTemplatedEmailRequest & WithReturnPath (const char *value)
 
const Aws::String & GetSourceArn () const
 
bool SourceArnHasBeenSet () const
 
void SetSourceArn (const Aws::String &value)
 
void SetSourceArn (Aws::String &&value)
 
void SetSourceArn (const char *value)
 
SendTemplatedEmailRequest & WithSourceArn (const Aws::String &value)
 
SendTemplatedEmailRequest & WithSourceArn (Aws::String &&value)
 
SendTemplatedEmailRequest & WithSourceArn (const char *value)
 
const Aws::String & GetReturnPathArn () const
 
bool ReturnPathArnHasBeenSet () const
 
void SetReturnPathArn (const Aws::String &value)
 
void SetReturnPathArn (Aws::String &&value)
 
void SetReturnPathArn (const char *value)
 
SendTemplatedEmailRequest & WithReturnPathArn (const Aws::String &value)
 
SendTemplatedEmailRequest & WithReturnPathArn (Aws::String &&value)
 
SendTemplatedEmailRequest & WithReturnPathArn (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)
 
SendTemplatedEmailRequest & WithTags (const Aws::Vector< MessageTag > &value)
 
SendTemplatedEmailRequest & WithTags (Aws::Vector< MessageTag > &&value)
 
SendTemplatedEmailRequest & AddTags (const MessageTag &value)
 
SendTemplatedEmailRequest & AddTags (MessageTag &&value)
 
const Aws::String & GetConfigurationSetName () const
 
bool ConfigurationSetNameHasBeenSet () const
 
void SetConfigurationSetName (const Aws::String &value)
 
void SetConfigurationSetName (Aws::String &&value)
 
void SetConfigurationSetName (const char *value)
 
SendTemplatedEmailRequest & WithConfigurationSetName (const Aws::String &value)
 
SendTemplatedEmailRequest & WithConfigurationSetName (Aws::String &&value)
 
SendTemplatedEmailRequest & WithConfigurationSetName (const char *value)
 
const Aws::String & GetTemplate () const
 
bool TemplateHasBeenSet () const
 
void SetTemplate (const Aws::String &value)
 
void SetTemplate (Aws::String &&value)
 
void SetTemplate (const char *value)
 
SendTemplatedEmailRequest & WithTemplate (const Aws::String &value)
 
SendTemplatedEmailRequest & WithTemplate (Aws::String &&value)
 
SendTemplatedEmailRequest & WithTemplate (const char *value)
 
const Aws::String & GetTemplateArn () const
 
bool TemplateArnHasBeenSet () const
 
void SetTemplateArn (const Aws::String &value)
 
void SetTemplateArn (Aws::String &&value)
 
void SetTemplateArn (const char *value)
 
SendTemplatedEmailRequest & WithTemplateArn (const Aws::String &value)
 
SendTemplatedEmailRequest & WithTemplateArn (Aws::String &&value)
 
SendTemplatedEmailRequest & WithTemplateArn (const char *value)
 
const Aws::String & GetTemplateData () const
 
bool TemplateDataHasBeenSet () const
 
void SetTemplateData (const Aws::String &value)
 
void SetTemplateData (Aws::String &&value)
 
void SetTemplateData (const char *value)
 
SendTemplatedEmailRequest & WithTemplateData (const Aws::String &value)
 
SendTemplatedEmailRequest & WithTemplateData (Aws::String &&value)
 
SendTemplatedEmailRequest & WithTemplateData (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::IOStream > GetBody () 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 RequestSignedHandler & GetRequestSignedHandler () const
 
const Aws::IOStreamFactory & GetResponseStreamFactory () 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::DataReceivedEventHandler & GetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const
 
virtual const RequestRetryHandler & GetRequestRetryHandler () 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 templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

AWS API Reference

Definition at line 30 of file SendTemplatedEmailRequest.h.

Constructor & Destructor Documentation

◆ SendTemplatedEmailRequest()

Aws::SES::Model::SendTemplatedEmailRequest::SendTemplatedEmailRequest ( )

Member Function Documentation

◆ AddReplyToAddresses() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 348 of file SendTemplatedEmailRequest.h.

◆ AddReplyToAddresses() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 342 of file SendTemplatedEmailRequest.h.

◆ AddReplyToAddresses() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 354 of file SendTemplatedEmailRequest.h.

◆ AddTags() [1/2]

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

Definition at line 766 of file SendTemplatedEmailRequest.h.

◆ AddTags() [2/2]

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

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

Definition at line 774 of file SendTemplatedEmailRequest.h.

◆ ConfigurationSetNameHasBeenSet()

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

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

Definition at line 787 of file SendTemplatedEmailRequest.h.

◆ DestinationHasBeenSet()

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

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Definition at line 275 of file SendTemplatedEmailRequest.h.

◆ DumpBodyToUrl()

void Aws::SES::Model::SendTemplatedEmailRequest::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::SendTemplatedEmailRequest::GetConfigurationSetName ( ) const
inline

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

Definition at line 781 of file SendTemplatedEmailRequest.h.

◆ GetDestination()

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

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Definition at line 269 of file SendTemplatedEmailRequest.h.

◆ GetReplyToAddresses()

const Aws::Vector<Aws::String>& Aws::SES::Model::SendTemplatedEmailRequest::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 306 of file SendTemplatedEmailRequest.h.

◆ GetReturnPath()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::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 366 of file SendTemplatedEmailRequest.h.

◆ GetReturnPathArn()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::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 590 of file SendTemplatedEmailRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file SendTemplatedEmailRequest.h.

◆ GetSource()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 73 of file SendTemplatedEmailRequest.h.

◆ GetSourceArn()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::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 460 of file SendTemplatedEmailRequest.h.

◆ GetTags()

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

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

Definition at line 718 of file SendTemplatedEmailRequest.h.

◆ GetTemplate()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::GetTemplate ( ) const
inline

The template to use when sending this email.

Definition at line 829 of file SendTemplatedEmailRequest.h.

◆ GetTemplateArn()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::GetTemplateArn ( ) const
inline

The ARN of the template to use when sending this email.

Definition at line 870 of file SendTemplatedEmailRequest.h.

◆ GetTemplateData()

const Aws::String& Aws::SES::Model::SendTemplatedEmailRequest::GetTemplateData ( ) const
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 913 of file SendTemplatedEmailRequest.h.

◆ ReplyToAddressesHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::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 312 of file SendTemplatedEmailRequest.h.

◆ ReturnPathArnHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::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 607 of file SendTemplatedEmailRequest.h.

◆ ReturnPathHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::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 377 of file SendTemplatedEmailRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConfigurationSetName() [1/3]

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

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

Definition at line 799 of file SendTemplatedEmailRequest.h.

◆ SetConfigurationSetName() [2/3]

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

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

Definition at line 793 of file SendTemplatedEmailRequest.h.

◆ SetConfigurationSetName() [3/3]

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

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

Definition at line 805 of file SendTemplatedEmailRequest.h.

◆ SetDestination() [1/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Definition at line 281 of file SendTemplatedEmailRequest.h.

◆ SetDestination() [2/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Definition at line 287 of file SendTemplatedEmailRequest.h.

◆ SetReplyToAddresses() [1/2]

void Aws::SES::Model::SendTemplatedEmailRequest::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 324 of file SendTemplatedEmailRequest.h.

◆ SetReplyToAddresses() [2/2]

void Aws::SES::Model::SendTemplatedEmailRequest::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 318 of file SendTemplatedEmailRequest.h.

◆ SetReturnPath() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 399 of file SendTemplatedEmailRequest.h.

◆ SetReturnPath() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 388 of file SendTemplatedEmailRequest.h.

◆ SetReturnPath() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 410 of file SendTemplatedEmailRequest.h.

◆ SetReturnPathArn() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 641 of file SendTemplatedEmailRequest.h.

◆ SetReturnPathArn() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 624 of file SendTemplatedEmailRequest.h.

◆ SetReturnPathArn() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 658 of file SendTemplatedEmailRequest.h.

◆ SetSource() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 154 of file SendTemplatedEmailRequest.h.

◆ SetSource() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 127 of file SendTemplatedEmailRequest.h.

◆ SetSource() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 181 of file SendTemplatedEmailRequest.h.

◆ SetSourceArn() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 508 of file SendTemplatedEmailRequest.h.

◆ SetSourceArn() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 492 of file SendTemplatedEmailRequest.h.

◆ SetSourceArn() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::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 524 of file SendTemplatedEmailRequest.h.

◆ SetTags() [1/2]

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

Definition at line 742 of file SendTemplatedEmailRequest.h.

◆ SetTags() [2/2]

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

Definition at line 734 of file SendTemplatedEmailRequest.h.

◆ SetTemplate() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplate ( Aws::String &&  value)
inline

The template to use when sending this email.

Definition at line 844 of file SendTemplatedEmailRequest.h.

◆ SetTemplate() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplate ( const Aws::String &  value)
inline

The template to use when sending this email.

Definition at line 839 of file SendTemplatedEmailRequest.h.

◆ SetTemplate() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplate ( const char *  value)
inline

The template to use when sending this email.

Definition at line 849 of file SendTemplatedEmailRequest.h.

◆ SetTemplateArn() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplateArn ( Aws::String &&  value)
inline

The ARN of the template to use when sending this email.

Definition at line 885 of file SendTemplatedEmailRequest.h.

◆ SetTemplateArn() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplateArn ( const Aws::String &  value)
inline

The ARN of the template to use when sending this email.

Definition at line 880 of file SendTemplatedEmailRequest.h.

◆ SetTemplateArn() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplateArn ( const char *  value)
inline

The ARN of the template to use when sending this email.

Definition at line 890 of file SendTemplatedEmailRequest.h.

◆ SetTemplateData() [1/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplateData ( Aws::String &&  value)
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 934 of file SendTemplatedEmailRequest.h.

◆ SetTemplateData() [2/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplateData ( const Aws::String &  value)
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 927 of file SendTemplatedEmailRequest.h.

◆ SetTemplateData() [3/3]

void Aws::SES::Model::SendTemplatedEmailRequest::SetTemplateData ( const char *  value)
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 941 of file SendTemplatedEmailRequest.h.

◆ SourceArnHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::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 476 of file SendTemplatedEmailRequest.h.

◆ SourceHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 100 of file SendTemplatedEmailRequest.h.

◆ TagsHasBeenSet()

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

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

Definition at line 726 of file SendTemplatedEmailRequest.h.

◆ TemplateArnHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::TemplateArnHasBeenSet ( ) const
inline

The ARN of the template to use when sending this email.

Definition at line 875 of file SendTemplatedEmailRequest.h.

◆ TemplateDataHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::TemplateDataHasBeenSet ( ) const
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 920 of file SendTemplatedEmailRequest.h.

◆ TemplateHasBeenSet()

bool Aws::SES::Model::SendTemplatedEmailRequest::TemplateHasBeenSet ( ) const
inline

The template to use when sending this email.

Definition at line 834 of file SendTemplatedEmailRequest.h.

◆ WithConfigurationSetName() [1/3]

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

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

Definition at line 817 of file SendTemplatedEmailRequest.h.

◆ WithConfigurationSetName() [2/3]

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

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

Definition at line 811 of file SendTemplatedEmailRequest.h.

◆ WithConfigurationSetName() [3/3]

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

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

Definition at line 823 of file SendTemplatedEmailRequest.h.

◆ WithDestination() [1/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Definition at line 293 of file SendTemplatedEmailRequest.h.

◆ WithDestination() [2/2]

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

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Definition at line 299 of file SendTemplatedEmailRequest.h.

◆ WithReplyToAddresses() [1/2]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 336 of file SendTemplatedEmailRequest.h.

◆ WithReplyToAddresses() [2/2]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 330 of file SendTemplatedEmailRequest.h.

◆ WithReturnPath() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 432 of file SendTemplatedEmailRequest.h.

◆ WithReturnPath() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 421 of file SendTemplatedEmailRequest.h.

◆ WithReturnPath() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 443 of file SendTemplatedEmailRequest.h.

◆ WithReturnPathArn() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 692 of file SendTemplatedEmailRequest.h.

◆ WithReturnPathArn() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 675 of file SendTemplatedEmailRequest.h.

◆ WithReturnPathArn() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 709 of file SendTemplatedEmailRequest.h.

◆ WithSource() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 235 of file SendTemplatedEmailRequest.h.

◆ WithSource() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 208 of file SendTemplatedEmailRequest.h.

◆ WithSource() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Definition at line 262 of file SendTemplatedEmailRequest.h.

◆ WithSourceArn() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 556 of file SendTemplatedEmailRequest.h.

◆ WithSourceArn() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 540 of file SendTemplatedEmailRequest.h.

◆ WithSourceArn() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::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 572 of file SendTemplatedEmailRequest.h.

◆ WithTags() [1/2]

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

Definition at line 758 of file SendTemplatedEmailRequest.h.

◆ WithTags() [2/2]

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

Definition at line 750 of file SendTemplatedEmailRequest.h.

◆ WithTemplate() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplate ( Aws::String &&  value)
inline

The template to use when sending this email.

Definition at line 859 of file SendTemplatedEmailRequest.h.

◆ WithTemplate() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplate ( const Aws::String &  value)
inline

The template to use when sending this email.

Definition at line 854 of file SendTemplatedEmailRequest.h.

◆ WithTemplate() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplate ( const char *  value)
inline

The template to use when sending this email.

Definition at line 864 of file SendTemplatedEmailRequest.h.

◆ WithTemplateArn() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplateArn ( Aws::String &&  value)
inline

The ARN of the template to use when sending this email.

Definition at line 900 of file SendTemplatedEmailRequest.h.

◆ WithTemplateArn() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplateArn ( const Aws::String &  value)
inline

The ARN of the template to use when sending this email.

Definition at line 895 of file SendTemplatedEmailRequest.h.

◆ WithTemplateArn() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplateArn ( const char *  value)
inline

The ARN of the template to use when sending this email.

Definition at line 905 of file SendTemplatedEmailRequest.h.

◆ WithTemplateData() [1/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplateData ( Aws::String &&  value)
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 955 of file SendTemplatedEmailRequest.h.

◆ WithTemplateData() [2/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplateData ( const Aws::String &  value)
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 948 of file SendTemplatedEmailRequest.h.

◆ WithTemplateData() [3/3]

SendTemplatedEmailRequest& Aws::SES::Model::SendTemplatedEmailRequest::WithTemplateData ( const char *  value)
inline

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Definition at line 962 of file SendTemplatedEmailRequest.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.19
Privacy | Site terms | Cookie preferences