public class SendTemplatedEmailRequest extends AmazonWebServiceRequest implements java.io.Serializable
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the SendTemplatedEmail
operation,
your call to the API must meet the following requirements:
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Calls to the SendTemplatedEmail
operation may only include one
Destination
parameter. A destination is a set of recipients who
will receive the same version of the email. The Destination
parameter can include up to 50 recipients, across the To:, CC: and BCC:
fields.
The Destination
parameter must include at least one recipient
email address. The recipient address can be a To: address, a CC: address, or
a BCC: address. If a recipient email address is invalid (that is, it is not
in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire
message will be rejected, even if the message contains other recipients that
are valid.
If your call to the SendTemplatedEmail
operation includes all of
the required parameters, Amazon SES accepts it and returns a Message ID.
However, if Amazon SES can't render the email because the template contains
errors, it doesn't send the email. Additionally, because it already accepted
the message, Amazon SES doesn't return a message stating that it was unable
to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
Constructor and Description |
---|
SendTemplatedEmailRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.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.
|
java.util.List<java.lang.String> |
getReplyToAddresses()
The reply-to email address(es) for the message.
|
java.lang.String |
getReturnPath()
The email address that bounces and complaints will be forwarded to when
feedback forwarding is enabled.
|
java.lang.String |
getReturnPathArn()
This parameter is used only for sending authorization.
|
java.lang.String |
getSource()
The email address that is sending the email.
|
java.lang.String |
getSourceArn()
This parameter is used only for sending authorization.
|
java.util.List<MessageTag> |
getTags()
A list of tags, in the form of name/value pairs, to apply to an email
that you send using
SendTemplatedEmail . |
java.lang.String |
getTemplate()
The template to use when sending this email.
|
java.lang.String |
getTemplateArn()
The ARN of the template to use when sending this email.
|
java.lang.String |
getTemplateData()
A list of replacement values to apply to the template.
|
int |
hashCode() |
void |
setConfigurationSetName(java.lang.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(java.util.Collection<java.lang.String> replyToAddresses)
The reply-to email address(es) for the message.
|
void |
setReturnPath(java.lang.String returnPath)
The email address that bounces and complaints will be forwarded to when
feedback forwarding is enabled.
|
void |
setReturnPathArn(java.lang.String returnPathArn)
This parameter is used only for sending authorization.
|
void |
setSource(java.lang.String source)
The email address that is sending the email.
|
void |
setSourceArn(java.lang.String sourceArn)
This parameter is used only for sending authorization.
|
void |
setTags(java.util.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(java.lang.String template)
The template to use when sending this email.
|
void |
setTemplateArn(java.lang.String templateArn)
The ARN of the template to use when sending this email.
|
void |
setTemplateData(java.lang.String templateData)
A list of replacement values to apply to the template.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SendTemplatedEmailRequest |
withConfigurationSetName(java.lang.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(java.util.Collection<java.lang.String> replyToAddresses)
The reply-to email address(es) for the message.
|
SendTemplatedEmailRequest |
withReplyToAddresses(java.lang.String... replyToAddresses)
The reply-to email address(es) for the message.
|
SendTemplatedEmailRequest |
withReturnPath(java.lang.String returnPath)
The email address that bounces and complaints will be forwarded to when
feedback forwarding is enabled.
|
SendTemplatedEmailRequest |
withReturnPathArn(java.lang.String returnPathArn)
This parameter is used only for sending authorization.
|
SendTemplatedEmailRequest |
withSource(java.lang.String source)
The email address that is sending the email.
|
SendTemplatedEmailRequest |
withSourceArn(java.lang.String sourceArn)
This parameter is used only for sending authorization.
|
SendTemplatedEmailRequest |
withTags(java.util.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(java.lang.String template)
The template to use when sending this email.
|
SendTemplatedEmailRequest |
withTemplateArn(java.lang.String templateArn)
The ARN of the template to use when sending this email.
|
SendTemplatedEmailRequest |
withTemplateData(java.lang.String templateData)
A list of replacement values to apply to the template.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.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 local part of a source email address (the part of the email
address that precedes the @ sign) may only contain 7-bit ASCII
characters. If the domain part of an address (the part after
the @ sign) contains non-ASCII characters, they must be encoded using
Punycode, as described in RFC3492. The sender
name (also known as the friendly name) may contain non-ASCII
characters. These characters must be encoded using MIME encoded-word
syntax, as described inRFC
2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been
permitted to do so by a sending authorization policy, then you
must also specify the SourceArn
parameter. For more
information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described
in RFC6531. For
this reason, the local part of a source email address (the
part of the email address that precedes the @ sign) may only
contain 7-bit ASCII characters. If the domain part of an
address (the part after the @ sign) contains non-ASCII
characters, they must be encoded using Punycode, as described in
RFC3492.
The sender name (also known as the friendly name) may
contain non-ASCII characters. These characters must be encoded
using MIME encoded-word syntax, as described inRFC 2047. MIME
encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.
public void setSource(java.lang.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 local part of a source email address (the part of the email
address that precedes the @ sign) may only contain 7-bit ASCII
characters. If the domain part of an address (the part after
the @ sign) contains non-ASCII characters, they must be encoded using
Punycode, as described in RFC3492. The sender
name (also known as the friendly name) may contain non-ASCII
characters. These characters must be encoded using MIME encoded-word
syntax, as described inRFC
2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.
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 local part of a source email address
(the part of the email address that precedes the @ sign) may
only contain 7-bit
ASCII characters. If the domain part of an address
(the part after the @ sign) contains non-ASCII characters,
they must be encoded using Punycode, as described in RFC3492.
The sender name (also known as the friendly name) may
contain non-ASCII characters. These characters must be encoded
using MIME encoded-word syntax, as described inRFC 2047. MIME
encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.
public SendTemplatedEmailRequest withSource(java.lang.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 local part of a source email address (the part of the email
address that precedes the @ sign) may only contain 7-bit ASCII
characters. If the domain part of an address (the part after
the @ sign) contains non-ASCII characters, they must be encoded using
Punycode, as described in RFC3492. The sender
name (also known as the friendly name) may contain non-ASCII
characters. These characters must be encoded using MIME encoded-word
syntax, as described inRFC
2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.
Returns a reference to this object so that method calls can be chained together.
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 local part of a source email address
(the part of the email address that precedes the @ sign) may
only contain 7-bit
ASCII characters. If the domain part of an address
(the part after the @ sign) contains non-ASCII characters,
they must be encoded using Punycode, as described in RFC3492.
The sender name (also known as the friendly name) may
contain non-ASCII characters. These characters must be encoded
using MIME encoded-word syntax, as described inRFC 2047. MIME
encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.
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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.List<java.lang.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.
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(java.util.Collection<java.lang.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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.util.Collection<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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.
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 setReturnPath(java.lang.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 SendTemplatedEmailRequest withReturnPath(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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.
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 setSourceArn(java.lang.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 SendTemplatedEmailRequest withSourceArn(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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.
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 void setReturnPathArn(java.lang.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 SendTemplatedEmailRequest withReturnPathArn(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.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.
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 setTags(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getConfigurationSetName()
The name of the configuration set to use when you send an email using
SendTemplatedEmail
.
The name of the configuration set to use when you send an email
using SendTemplatedEmail
.
public void setConfigurationSetName(java.lang.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 SendTemplatedEmailRequest withConfigurationSetName(java.lang.String configurationSetName)
The name of the configuration set to use when you send an email using
SendTemplatedEmail
.
Returns a reference to this object so that method calls can be chained together.
configurationSetName
-
The name of the configuration set to use when you send an
email using SendTemplatedEmail
.
public java.lang.String getTemplate()
The template to use when sending this email.
The template to use when sending this email.
public void setTemplate(java.lang.String template)
The template to use when sending this email.
template
- The template to use when sending this email.
public SendTemplatedEmailRequest withTemplate(java.lang.String template)
The template to use when sending this email.
Returns a reference to this object so that method calls can be chained together.
template
- The template to use when sending this email.
public java.lang.String getTemplateArn()
The ARN of the template to use when sending this email.
The ARN of the template to use when sending this email.
public void setTemplateArn(java.lang.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 SendTemplatedEmailRequest withTemplateArn(java.lang.String templateArn)
The ARN of the template to use when sending this email.
Returns a reference to this object so that method calls can be chained together.
templateArn
- The ARN of the template to use when sending this email.
public java.lang.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.
Constraints:
Length: - 262144
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 void setTemplateData(java.lang.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.
Constraints:
Length: - 262144
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 SendTemplatedEmailRequest withTemplateData(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 262144
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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.