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

#include <SendBulkTemplatedEmailRequest.h>

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

Public Member Functions

 SendBulkTemplatedEmailRequest ()
 
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)
 
SendBulkTemplatedEmailRequestWithSource (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithSource (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithSource (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)
 
SendBulkTemplatedEmailRequestWithSourceArn (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithSourceArn (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithSourceArn (const char *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)
 
SendBulkTemplatedEmailRequestWithReplyToAddresses (const Aws::Vector< Aws::String > &value)
 
SendBulkTemplatedEmailRequestWithReplyToAddresses (Aws::Vector< Aws::String > &&value)
 
SendBulkTemplatedEmailRequestAddReplyToAddresses (const Aws::String &value)
 
SendBulkTemplatedEmailRequestAddReplyToAddresses (Aws::String &&value)
 
SendBulkTemplatedEmailRequestAddReplyToAddresses (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)
 
SendBulkTemplatedEmailRequestWithReturnPath (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithReturnPath (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithReturnPath (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)
 
SendBulkTemplatedEmailRequestWithReturnPathArn (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithReturnPathArn (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithReturnPathArn (const char *value)
 
const Aws::StringGetConfigurationSetName () const
 
bool ConfigurationSetNameHasBeenSet () const
 
void SetConfigurationSetName (const Aws::String &value)
 
void SetConfigurationSetName (Aws::String &&value)
 
void SetConfigurationSetName (const char *value)
 
SendBulkTemplatedEmailRequestWithConfigurationSetName (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithConfigurationSetName (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithConfigurationSetName (const char *value)
 
const Aws::Vector< MessageTag > & GetDefaultTags () const
 
bool DefaultTagsHasBeenSet () const
 
void SetDefaultTags (const Aws::Vector< MessageTag > &value)
 
void SetDefaultTags (Aws::Vector< MessageTag > &&value)
 
SendBulkTemplatedEmailRequestWithDefaultTags (const Aws::Vector< MessageTag > &value)
 
SendBulkTemplatedEmailRequestWithDefaultTags (Aws::Vector< MessageTag > &&value)
 
SendBulkTemplatedEmailRequestAddDefaultTags (const MessageTag &value)
 
SendBulkTemplatedEmailRequestAddDefaultTags (MessageTag &&value)
 
const Aws::StringGetTemplate () const
 
bool TemplateHasBeenSet () const
 
void SetTemplate (const Aws::String &value)
 
void SetTemplate (Aws::String &&value)
 
void SetTemplate (const char *value)
 
SendBulkTemplatedEmailRequestWithTemplate (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithTemplate (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithTemplate (const char *value)
 
const Aws::StringGetTemplateArn () const
 
bool TemplateArnHasBeenSet () const
 
void SetTemplateArn (const Aws::String &value)
 
void SetTemplateArn (Aws::String &&value)
 
void SetTemplateArn (const char *value)
 
SendBulkTemplatedEmailRequestWithTemplateArn (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithTemplateArn (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithTemplateArn (const char *value)
 
const Aws::StringGetDefaultTemplateData () const
 
bool DefaultTemplateDataHasBeenSet () const
 
void SetDefaultTemplateData (const Aws::String &value)
 
void SetDefaultTemplateData (Aws::String &&value)
 
void SetDefaultTemplateData (const char *value)
 
SendBulkTemplatedEmailRequestWithDefaultTemplateData (const Aws::String &value)
 
SendBulkTemplatedEmailRequestWithDefaultTemplateData (Aws::String &&value)
 
SendBulkTemplatedEmailRequestWithDefaultTemplateData (const char *value)
 
const Aws::Vector< BulkEmailDestination > & GetDestinations () const
 
bool DestinationsHasBeenSet () const
 
void SetDestinations (const Aws::Vector< BulkEmailDestination > &value)
 
void SetDestinations (Aws::Vector< BulkEmailDestination > &&value)
 
SendBulkTemplatedEmailRequestWithDestinations (const Aws::Vector< BulkEmailDestination > &value)
 
SendBulkTemplatedEmailRequestWithDestinations (Aws::Vector< BulkEmailDestination > &&value)
 
SendBulkTemplatedEmailRequestAddDestinations (const BulkEmailDestination &value)
 
SendBulkTemplatedEmailRequestAddDestinations (BulkEmailDestination &&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 templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

AWS API Reference

Definition at line 30 of file SendBulkTemplatedEmailRequest.h.

Constructor & Destructor Documentation

◆ SendBulkTemplatedEmailRequest()

Aws::SES::Model::SendBulkTemplatedEmailRequest::SendBulkTemplatedEmailRequest ( )

Member Function Documentation

◆ AddDefaultTags() [1/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::AddDefaultTags ( const MessageTag value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Definition at line 764 of file SendBulkTemplatedEmailRequest.h.

◆ AddDefaultTags() [2/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::AddDefaultTags ( MessageTag &&  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Definition at line 770 of file SendBulkTemplatedEmailRequest.h.

◆ AddDestinations() [1/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::AddDestinations ( BulkEmailDestination &&  value)
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 990 of file SendBulkTemplatedEmailRequest.h.

◆ AddDestinations() [2/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::AddDestinations ( const BulkEmailDestination value)
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 982 of file SendBulkTemplatedEmailRequest.h.

◆ AddReplyToAddresses() [1/3]

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

◆ AddReplyToAddresses() [2/3]

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

◆ AddReplyToAddresses() [3/3]

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

◆ ConfigurationSetNameHasBeenSet()

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

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

Definition at line 685 of file SendBulkTemplatedEmailRequest.h.

◆ DefaultTagsHasBeenSet()

bool Aws::SES::Model::SendBulkTemplatedEmailRequest::DefaultTagsHasBeenSet ( ) const
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Definition at line 734 of file SendBulkTemplatedEmailRequest.h.

◆ DefaultTemplateDataHasBeenSet()

bool Aws::SES::Model::SendBulkTemplatedEmailRequest::DefaultTemplateDataHasBeenSet ( ) const
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 871 of file SendBulkTemplatedEmailRequest.h.

◆ DestinationsHasBeenSet()

bool Aws::SES::Model::SendBulkTemplatedEmailRequest::DestinationsHasBeenSet ( ) const
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 942 of file SendBulkTemplatedEmailRequest.h.

◆ DumpBodyToUrl()

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

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

Definition at line 679 of file SendBulkTemplatedEmailRequest.h.

◆ GetDefaultTags()

const Aws::Vector<MessageTag>& Aws::SES::Model::SendBulkTemplatedEmailRequest::GetDefaultTags ( ) const
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Definition at line 728 of file SendBulkTemplatedEmailRequest.h.

◆ GetDefaultTemplateData()

const Aws::String& Aws::SES::Model::SendBulkTemplatedEmailRequest::GetDefaultTemplateData ( ) const
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 862 of file SendBulkTemplatedEmailRequest.h.

◆ GetDestinations()

const Aws::Vector<BulkEmailDestination>& Aws::SES::Model::SendBulkTemplatedEmailRequest::GetDestinations ( ) const
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 934 of file SendBulkTemplatedEmailRequest.h.

◆ GetReplyToAddresses()

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

◆ GetReturnPath()

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

◆ GetReturnPathArn()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file SendBulkTemplatedEmailRequest.h.

◆ GetSource()

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

◆ GetSourceArn()

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

◆ GetTemplate()

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

The template to use when sending this email.

Definition at line 776 of file SendBulkTemplatedEmailRequest.h.

◆ GetTemplateArn()

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

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

Definition at line 817 of file SendBulkTemplatedEmailRequest.h.

◆ ReplyToAddressesHasBeenSet()

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

◆ ReturnPathArnHasBeenSet()

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

◆ ReturnPathHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConfigurationSetName() [1/3]

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

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

Definition at line 697 of file SendBulkTemplatedEmailRequest.h.

◆ SetConfigurationSetName() [2/3]

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

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

Definition at line 691 of file SendBulkTemplatedEmailRequest.h.

◆ SetConfigurationSetName() [3/3]

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

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

Definition at line 703 of file SendBulkTemplatedEmailRequest.h.

◆ SetDefaultTags() [1/2]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDefaultTags ( Aws::Vector< MessageTag > &&  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Definition at line 746 of file SendBulkTemplatedEmailRequest.h.

◆ SetDefaultTags() [2/2]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDefaultTags ( 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 to a destination using SendBulkTemplatedEmail.

Definition at line 740 of file SendBulkTemplatedEmailRequest.h.

◆ SetDefaultTemplateData() [1/3]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDefaultTemplateData ( Aws::String &&  value)
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 889 of file SendBulkTemplatedEmailRequest.h.

◆ SetDefaultTemplateData() [2/3]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDefaultTemplateData ( const Aws::String value)
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 880 of file SendBulkTemplatedEmailRequest.h.

◆ SetDefaultTemplateData() [3/3]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDefaultTemplateData ( const char *  value)
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 898 of file SendBulkTemplatedEmailRequest.h.

◆ SetDestinations() [1/2]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDestinations ( Aws::Vector< BulkEmailDestination > &&  value)
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 958 of file SendBulkTemplatedEmailRequest.h.

◆ SetDestinations() [2/2]

void Aws::SES::Model::SendBulkTemplatedEmailRequest::SetDestinations ( const Aws::Vector< BulkEmailDestination > &  value)
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 950 of file SendBulkTemplatedEmailRequest.h.

◆ SetReplyToAddresses() [1/2]

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

◆ SetReplyToAddresses() [2/2]

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

◆ SetReturnPath() [1/3]

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

◆ SetReturnPath() [2/3]

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

◆ SetReturnPath() [3/3]

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

◆ SetReturnPathArn() [1/3]

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

◆ SetReturnPathArn() [2/3]

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

◆ SetReturnPathArn() [3/3]

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

◆ SetSource() [1/3]

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

◆ SetSource() [2/3]

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

◆ SetSource() [3/3]

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

◆ SetSourceArn() [1/3]

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

◆ SetSourceArn() [2/3]

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

◆ SetSourceArn() [3/3]

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

◆ SetTemplate() [1/3]

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

The template to use when sending this email.

Definition at line 791 of file SendBulkTemplatedEmailRequest.h.

◆ SetTemplate() [2/3]

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

The template to use when sending this email.

Definition at line 786 of file SendBulkTemplatedEmailRequest.h.

◆ SetTemplate() [3/3]

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

The template to use when sending this email.

Definition at line 796 of file SendBulkTemplatedEmailRequest.h.

◆ SetTemplateArn() [1/3]

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

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

Definition at line 832 of file SendBulkTemplatedEmailRequest.h.

◆ SetTemplateArn() [2/3]

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

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

Definition at line 827 of file SendBulkTemplatedEmailRequest.h.

◆ SetTemplateArn() [3/3]

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

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

Definition at line 837 of file SendBulkTemplatedEmailRequest.h.

◆ SourceArnHasBeenSet()

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

◆ SourceHasBeenSet()

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

◆ TemplateArnHasBeenSet()

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

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

Definition at line 822 of file SendBulkTemplatedEmailRequest.h.

◆ TemplateHasBeenSet()

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

The template to use when sending this email.

Definition at line 781 of file SendBulkTemplatedEmailRequest.h.

◆ WithConfigurationSetName() [1/3]

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

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

Definition at line 715 of file SendBulkTemplatedEmailRequest.h.

◆ WithConfigurationSetName() [2/3]

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

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

Definition at line 709 of file SendBulkTemplatedEmailRequest.h.

◆ WithConfigurationSetName() [3/3]

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

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

Definition at line 721 of file SendBulkTemplatedEmailRequest.h.

◆ WithDefaultTags() [1/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDefaultTags ( Aws::Vector< MessageTag > &&  value)
inline

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Definition at line 758 of file SendBulkTemplatedEmailRequest.h.

◆ WithDefaultTags() [2/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDefaultTags ( 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 to a destination using SendBulkTemplatedEmail.

Definition at line 752 of file SendBulkTemplatedEmailRequest.h.

◆ WithDefaultTemplateData() [1/3]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDefaultTemplateData ( Aws::String &&  value)
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 916 of file SendBulkTemplatedEmailRequest.h.

◆ WithDefaultTemplateData() [2/3]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDefaultTemplateData ( const Aws::String value)
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 907 of file SendBulkTemplatedEmailRequest.h.

◆ WithDefaultTemplateData() [3/3]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDefaultTemplateData ( const char *  value)
inline

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data 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 925 of file SendBulkTemplatedEmailRequest.h.

◆ WithDestinations() [1/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDestinations ( Aws::Vector< BulkEmailDestination > &&  value)
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 974 of file SendBulkTemplatedEmailRequest.h.

◆ WithDestinations() [2/2]

SendBulkTemplatedEmailRequest& Aws::SES::Model::SendBulkTemplatedEmailRequest::WithDestinations ( const Aws::Vector< BulkEmailDestination > &  value)
inline

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Definition at line 966 of file SendBulkTemplatedEmailRequest.h.

◆ WithReplyToAddresses() [1/2]

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

◆ WithReplyToAddresses() [2/2]

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

◆ WithReturnPath() [1/3]

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

◆ WithReturnPath() [2/3]

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

◆ WithReturnPath() [3/3]

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

◆ WithReturnPathArn() [1/3]

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

◆ WithReturnPathArn() [2/3]

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

◆ WithReturnPathArn() [3/3]

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

◆ WithSource() [1/3]

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

◆ WithSource() [2/3]

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

◆ WithSource() [3/3]

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

◆ WithSourceArn() [1/3]

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

◆ WithSourceArn() [2/3]

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

◆ WithSourceArn() [3/3]

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

◆ WithTemplate() [1/3]

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

The template to use when sending this email.

Definition at line 806 of file SendBulkTemplatedEmailRequest.h.

◆ WithTemplate() [2/3]

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

The template to use when sending this email.

Definition at line 801 of file SendBulkTemplatedEmailRequest.h.

◆ WithTemplate() [3/3]

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

The template to use when sending this email.

Definition at line 811 of file SendBulkTemplatedEmailRequest.h.

◆ WithTemplateArn() [1/3]

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

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

Definition at line 847 of file SendBulkTemplatedEmailRequest.h.

◆ WithTemplateArn() [2/3]

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

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

Definition at line 842 of file SendBulkTemplatedEmailRequest.h.

◆ WithTemplateArn() [3/3]

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

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

Definition at line 852 of file SendBulkTemplatedEmailRequest.h.


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