com.amazonaws.services.simpleemail.model.SendTemplatedEmailRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simpleemail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SendTemplatedEmailRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
*/
private String source;
/**
*
* The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50
* recipients across these three fields.
*
*/
private Destination destination;
/**
*
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address
* receives the reply.
*
*/
private com.amazonaws.internal.SdkInternalList replyToAddresses;
/**
*
* 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.
*
*/
private String returnPath;
/**
*
* 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 [email protected], then you would specify the SourceArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*/
private 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 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 [email protected], then you would specify the ReturnPathArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*/
private String returnPathArn;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The name of the configuration set to use when you send an email using SendTemplatedEmail.
*
*/
private String configurationSetName;
/**
*
* The template to use when sending this email.
*
*/
private String template;
/**
*
* The ARN of the template to use when sending this email.
*
*/
private String templateArn;
/**
*
* 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.
*
*/
private String templateData;
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setSource(String source) {
this.source = 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.
*
*
*
* @return 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.
*
*/
public String getSource() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withSource(String source) {
setSource(source);
return this;
}
/**
*
* The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50
* recipients across these three fields.
*
*
* @param 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 void setDestination(Destination destination) {
this.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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withDestination(Destination destination) {
setDestination(destination);
return this;
}
/**
*
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address
* receives the reply.
*
*
* @return The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
* address receives the reply.
*/
public java.util.List getReplyToAddresses() {
if (replyToAddresses == null) {
replyToAddresses = new com.amazonaws.internal.SdkInternalList();
}
return replyToAddresses;
}
/**
*
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address
* receives the reply.
*
*
* @param replyToAddresses
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
* address receives the reply.
*/
public void setReplyToAddresses(java.util.Collection replyToAddresses) {
if (replyToAddresses == null) {
this.replyToAddresses = null;
return;
}
this.replyToAddresses = new com.amazonaws.internal.SdkInternalList(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
* {@link #setReplyToAddresses(java.util.Collection)} or {@link #withReplyToAddresses(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param replyToAddresses
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
* address receives the reply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withReplyToAddresses(String... replyToAddresses) {
if (this.replyToAddresses == null) {
setReplyToAddresses(new com.amazonaws.internal.SdkInternalList(replyToAddresses.length));
}
for (String ele : replyToAddresses) {
this.replyToAddresses.add(ele);
}
return this;
}
/**
*
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address
* receives the reply.
*
*
* @param replyToAddresses
* The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
* address receives the reply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withReplyToAddresses(java.util.Collection replyToAddresses) {
setReplyToAddresses(replyToAddresses);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setReturnPath(String returnPath) {
this.returnPath = 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.
*
*
* @return 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.
*/
public String getReturnPath() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withReturnPath(String returnPath) {
setReturnPath(returnPath);
return this;
}
/**
*
* 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 [email protected], then you would specify the SourceArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*
* @param 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 [email protected], then you would specify the
* SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
* Source to be [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer
* Guide.
*/
public void setSourceArn(String sourceArn) {
this.sourceArn = 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 [email protected], then you would specify the SourceArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*
* @return 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 [email protected], then you would specify the
* SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
* the Source to be [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer
* Guide.
*/
public String getSourceArn() {
return this.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 [email protected], then you would specify the SourceArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*
* @param 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 [email protected], then you would specify the
* SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
* Source to be [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withSourceArn(String sourceArn) {
setSourceArn(sourceArn);
return this;
}
/**
*
* 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 [email protected], then you would specify the ReturnPathArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*
* @param 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 [email protected], then you would specify the
* ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
* the ReturnPath to be [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer
* Guide.
*/
public void setReturnPathArn(String returnPathArn) {
this.returnPathArn = 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 [email protected], then you would specify the ReturnPathArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*
* @return 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 [email protected], then you would specify the
* ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
* and the ReturnPath to be [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer
* Guide.
*/
public String getReturnPathArn() {
return this.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 [email protected], then you would specify the ReturnPathArn to be
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
* [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer Guide.
*
*
* @param 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 [email protected], then you would specify the
* ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
* the ReturnPath to be [email protected].
*
*
* For more information about sending authorization, see the Amazon SES Developer
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withReturnPathArn(String returnPathArn) {
setReturnPathArn(returnPathArn);
return this;
}
/**
*
* 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.
*
*
* @return 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.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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 setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(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
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withTags(MessageTag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (MessageTag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The name of the configuration set to use when you send an email using SendTemplatedEmail.
*
*
* @param configurationSetName
* The name of the configuration set to use when you send an email using SendTemplatedEmail.
*/
public void setConfigurationSetName(String configurationSetName) {
this.configurationSetName = configurationSetName;
}
/**
*
* The name of the configuration set to use when you send an email using SendTemplatedEmail.
*
*
* @return The name of the configuration set to use when you send an email using SendTemplatedEmail.
*/
public String getConfigurationSetName() {
return this.configurationSetName;
}
/**
*
* The name of the configuration set to use when you send an email using SendTemplatedEmail.
*
*
* @param configurationSetName
* The name of the configuration set to use when you send an email using SendTemplatedEmail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withConfigurationSetName(String configurationSetName) {
setConfigurationSetName(configurationSetName);
return this;
}
/**
*
* The template to use when sending this email.
*
*
* @param template
* The template to use when sending this email.
*/
public void setTemplate(String template) {
this.template = template;
}
/**
*
* The template to use when sending this email.
*
*
* @return The template to use when sending this email.
*/
public String getTemplate() {
return this.template;
}
/**
*
* The template to use when sending this email.
*
*
* @param template
* The template to use when sending this email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withTemplate(String template) {
setTemplate(template);
return this;
}
/**
*
* The ARN of the template to use when sending this email.
*
*
* @param templateArn
* The ARN of the template to use when sending this email.
*/
public void setTemplateArn(String templateArn) {
this.templateArn = templateArn;
}
/**
*
* The ARN of the template to use when sending this email.
*
*
* @return The ARN of the template to use when sending this email.
*/
public String getTemplateArn() {
return this.templateArn;
}
/**
*
* The ARN of the template to use when sending this email.
*
*
* @param templateArn
* The ARN of the template to use when sending this email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withTemplateArn(String templateArn) {
setTemplateArn(templateArn);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setTemplateData(String templateData) {
this.templateData = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendTemplatedEmailRequest withTemplateData(String templateData) {
setTemplateData(templateData);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getReplyToAddresses() != null)
sb.append("ReplyToAddresses: ").append(getReplyToAddresses()).append(",");
if (getReturnPath() != null)
sb.append("ReturnPath: ").append(getReturnPath()).append(",");
if (getSourceArn() != null)
sb.append("SourceArn: ").append(getSourceArn()).append(",");
if (getReturnPathArn() != null)
sb.append("ReturnPathArn: ").append(getReturnPathArn()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getConfigurationSetName() != null)
sb.append("ConfigurationSetName: ").append(getConfigurationSetName()).append(",");
if (getTemplate() != null)
sb.append("Template: ").append(getTemplate()).append(",");
if (getTemplateArn() != null)
sb.append("TemplateArn: ").append(getTemplateArn()).append(",");
if (getTemplateData() != null)
sb.append("TemplateData: ").append(getTemplateData());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SendTemplatedEmailRequest == false)
return false;
SendTemplatedEmailRequest other = (SendTemplatedEmailRequest) obj;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
if (other.getReplyToAddresses() == null ^ this.getReplyToAddresses() == null)
return false;
if (other.getReplyToAddresses() != null && other.getReplyToAddresses().equals(this.getReplyToAddresses()) == false)
return false;
if (other.getReturnPath() == null ^ this.getReturnPath() == null)
return false;
if (other.getReturnPath() != null && other.getReturnPath().equals(this.getReturnPath()) == false)
return false;
if (other.getSourceArn() == null ^ this.getSourceArn() == null)
return false;
if (other.getSourceArn() != null && other.getSourceArn().equals(this.getSourceArn()) == false)
return false;
if (other.getReturnPathArn() == null ^ this.getReturnPathArn() == null)
return false;
if (other.getReturnPathArn() != null && other.getReturnPathArn().equals(this.getReturnPathArn()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getConfigurationSetName() == null ^ this.getConfigurationSetName() == null)
return false;
if (other.getConfigurationSetName() != null && other.getConfigurationSetName().equals(this.getConfigurationSetName()) == false)
return false;
if (other.getTemplate() == null ^ this.getTemplate() == null)
return false;
if (other.getTemplate() != null && other.getTemplate().equals(this.getTemplate()) == false)
return false;
if (other.getTemplateArn() == null ^ this.getTemplateArn() == null)
return false;
if (other.getTemplateArn() != null && other.getTemplateArn().equals(this.getTemplateArn()) == false)
return false;
if (other.getTemplateData() == null ^ this.getTemplateData() == null)
return false;
if (other.getTemplateData() != null && other.getTemplateData().equals(this.getTemplateData()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getReplyToAddresses() == null) ? 0 : getReplyToAddresses().hashCode());
hashCode = prime * hashCode + ((getReturnPath() == null) ? 0 : getReturnPath().hashCode());
hashCode = prime * hashCode + ((getSourceArn() == null) ? 0 : getSourceArn().hashCode());
hashCode = prime * hashCode + ((getReturnPathArn() == null) ? 0 : getReturnPathArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getConfigurationSetName() == null) ? 0 : getConfigurationSetName().hashCode());
hashCode = prime * hashCode + ((getTemplate() == null) ? 0 : getTemplate().hashCode());
hashCode = prime * hashCode + ((getTemplateArn() == null) ? 0 : getTemplateArn().hashCode());
hashCode = prime * hashCode + ((getTemplateData() == null) ? 0 : getTemplateData().hashCode());
return hashCode;
}
@Override
public SendTemplatedEmailRequest clone() {
return (SendTemplatedEmailRequest) super.clone();
}
}