@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.
NOOP
Constructor and Description |
---|
SendTemplatedEmailRequest() |
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 will be 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 will be 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; useful for testing and debugging.
|
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 will be 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.
|
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
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.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following
form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
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.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then
you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax
uses the following form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
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.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following
form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
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.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then
you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax
uses the following form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
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.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following
form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
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.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then
you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax
uses the following form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
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.
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.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.
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.
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.public List<String> getReplyToAddresses()
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
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 will receive the reply.
replyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
address will receive the reply.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 will receive 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.
replyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
address will receive the reply.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 will receive the reply.
replyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
address will receive the reply.public void setReturnPath(String returnPath)
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.
returnPath
- 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.public String getReturnPath()
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.
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.public SendTemplatedEmailRequest withReturnPath(String returnPath)
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.
returnPath
- 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.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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
SendTemplatedEmail
. Tags correspond to characteristics of the email that you define, so that
you can publish email sending events.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.
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.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.
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.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.
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.public void setConfigurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
configurationSetName
- The name of the configuration set to use when you send an email using SendTemplatedEmail
.public String getConfigurationSetName()
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
SendTemplatedEmail
.public SendTemplatedEmailRequest withConfigurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
configurationSetName
- The name of the configuration set to use when you send an email using SendTemplatedEmail
.public void setTemplate(String template)
The template to use when sending this email.
template
- The template to use when sending this email.public String getTemplate()
The template to use when sending this email.
public SendTemplatedEmailRequest withTemplate(String template)
The template to use when sending this email.
template
- The template to use when sending this email.public void setTemplateArn(String templateArn)
The ARN of the template to use when sending this email.
templateArn
- The ARN of the template to use when sending this email.public String getTemplateArn()
The ARN of the template to use when sending this email.
public SendTemplatedEmailRequest withTemplateArn(String templateArn)
The ARN of the template to use when sending this email.
templateArn
- The ARN of the template to use when sending this email.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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public SendTemplatedEmailRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.