com.amazonaws.services.simpleemail.model

Class SendTemplatedEmailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemail.model.SendTemplatedEmailRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendTemplatedEmailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendTemplatedEmailRequest()

Method Summary

Modifier and Type	Method and Description
SendTemplatedEmailRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConfigurationSetName() The name of the configuration set to use when you send an email using SendTemplatedEmail.
Destination	getDestination() The destination for this email, composed of To:, CC:, and BCC: fields.
List<String>	getReplyToAddresses() The reply-to email address(es) for the message.
String	getReturnPath() The email address that bounces and complaints are forwarded to when feedback forwarding is enabled.
String	getReturnPathArn() This parameter is used only for sending authorization.
String	getSource() The email address that is sending the email.
String	getSourceArn() This parameter is used only for sending authorization.
List<MessageTag>	getTags() A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
String	getTemplate() The template to use when sending this email.
String	getTemplateArn() The ARN of the template to use when sending this email.
String	getTemplateData() A list of replacement values to apply to the template.
int	hashCode()
void	setConfigurationSetName(String configurationSetName) The name of the configuration set to use when you send an email using SendTemplatedEmail.
void	setDestination(Destination destination) The destination for this email, composed of To:, CC:, and BCC: fields.
void	setReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the message.
void	setReturnPath(String returnPath) The email address that bounces and complaints are forwarded to when feedback forwarding is enabled.
void	setReturnPathArn(String returnPathArn) This parameter is used only for sending authorization.
void	setSource(String source) The email address that is sending the email.
void	setSourceArn(String sourceArn) This parameter is used only for sending authorization.
void	setTags(Collection<MessageTag> tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
void	setTemplate(String template) The template to use when sending this email.
void	setTemplateArn(String templateArn) The ARN of the template to use when sending this email.
void	setTemplateData(String templateData) A list of replacement values to apply to the template.
String	toString() Returns a string representation of this object.
SendTemplatedEmailRequest	withConfigurationSetName(String configurationSetName) The name of the configuration set to use when you send an email using SendTemplatedEmail.
SendTemplatedEmailRequest	withDestination(Destination destination) The destination for this email, composed of To:, CC:, and BCC: fields.
SendTemplatedEmailRequest	withReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the message.
SendTemplatedEmailRequest	withReplyToAddresses(String... replyToAddresses) The reply-to email address(es) for the message.
SendTemplatedEmailRequest	withReturnPath(String returnPath) The email address that bounces and complaints are forwarded to when feedback forwarding is enabled.
SendTemplatedEmailRequest	withReturnPathArn(String returnPathArn) This parameter is used only for sending authorization.
SendTemplatedEmailRequest	withSource(String source) The email address that is sending the email.
SendTemplatedEmailRequest	withSourceArn(String sourceArn) This parameter is used only for sending authorization.
SendTemplatedEmailRequest	withTags(Collection<MessageTag> tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
SendTemplatedEmailRequest	withTags(MessageTag... tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
SendTemplatedEmailRequest	withTemplate(String template) The template to use when sending this email.
SendTemplatedEmailRequest	withTemplateArn(String templateArn) The ARN of the template to use when sending this email.
SendTemplatedEmailRequest	withTemplateData(String templateData) A list of replacement values to apply to the template.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendTemplatedEmailRequest

public SendTemplatedEmailRequest()

Method Detail

setSource

public void setSource(String source)

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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Parameters:

source - 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

getSource

public String getSource()

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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Returns:

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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

withSource

public SendTemplatedEmailRequest withSource(String source)

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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Parameters:

source - 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDestination

public void setDestination(Destination destination)

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

Parameters:

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

getDestination

public Destination getDestination()

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

Returns:

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

withDestination

public SendTemplatedEmailRequest withDestination(Destination destination)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getReplyToAddresses

public List<String> getReplyToAddresses()

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

Returns:

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

setReplyToAddresses

public void setReplyToAddresses(Collection<String> replyToAddresses)

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

Parameters:

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

withReplyToAddresses

public SendTemplatedEmailRequest withReplyToAddresses(String... replyToAddresses)

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

NOTE: This method appends the values to the existing list (if any). Use setReplyToAddresses(java.util.Collection) or withReplyToAddresses(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withReplyToAddresses

public SendTemplatedEmailRequest withReplyToAddresses(Collection<String> replyToAddresses)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setReturnPath

public void setReturnPath(String returnPath)

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

Parameters:

returnPath - The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

getReturnPath

public String getReturnPath()

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

Returns:

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

withReturnPath

public SendTemplatedEmailRequest withReturnPath(String returnPath)

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

Parameters:

returnPath - The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceArn

public void setSourceArn(String sourceArn)

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@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

Parameters:

sourceArn - 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@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

getSourceArn

public String getSourceArn()

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@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

Returns:

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@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

withSourceArn

public SendTemplatedEmailRequest withSourceArn(String sourceArn)

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@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

Parameters:

sourceArn - 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@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setReturnPathArn

public void setReturnPathArn(String returnPathArn)

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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

Parameters:

returnPathArn - 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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

getReturnPathArn

public String getReturnPathArn()

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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

Returns:

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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

withReturnPathArn

public SendTemplatedEmailRequest withReturnPathArn(String returnPathArn)

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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

Parameters:

returnPathArn - 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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<MessageTag> getTags()

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.

Returns:

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.

setTags

public void setTags(Collection<MessageTag> tags)

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.

Parameters:

tags - 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.

withTags

public SendTemplatedEmailRequest withTags(MessageTag... tags)

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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public SendTemplatedEmailRequest withTags(Collection<MessageTag> tags)

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.

Parameters:

tags - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConfigurationSetName

public void setConfigurationSetName(String configurationSetName)

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

Parameters:

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

getConfigurationSetName

public String getConfigurationSetName()

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

Returns:

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

withConfigurationSetName

public SendTemplatedEmailRequest withConfigurationSetName(String configurationSetName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplate

public void setTemplate(String template)

The template to use when sending this email.

Parameters:

template - The template to use when sending this email.

getTemplate

public String getTemplate()

The template to use when sending this email.

Returns:

The template to use when sending this email.

withTemplate

public SendTemplatedEmailRequest withTemplate(String template)

The template to use when sending this email.

Parameters:

template - The template to use when sending this email.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateArn

public void setTemplateArn(String templateArn)

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

Parameters:

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

getTemplateArn

public String getTemplateArn()

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

Returns:

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

withTemplateArn

public SendTemplatedEmailRequest withTemplateArn(String templateArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateData

public void setTemplateData(String templateData)

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.

Parameters:

templateData - 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.

getTemplateData

public String getTemplateData()

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.

Returns:

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.

withTemplateData

public SendTemplatedEmailRequest withTemplateData(String templateData)

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.

Parameters:

templateData - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendTemplatedEmailRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()