/* * Copyright 2018-2023 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 single formatted 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 SendEmailRequest 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 local part of a source email * address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain * part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using * Punycode, as described in RFC3492. The sender name (also * known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME * encoded-word syntax, as described in RFC 2047. MIME * encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. *

* */ private String source; /** *

* The destination for this email, composed of To:, CC:, and BCC: fields. *

*/ private Destination destination; /** *

* The message to be sent. *

*/ private Message message; /** *

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

*/ private com.amazonaws.internal.SdkInternalList replyToAddresses; /** *

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

*/ 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 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. *

*/ 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 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. *

*/ private String returnPathArn; /** *

* A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. * 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 SendEmail. *

*/ private String configurationSetName; /** * Default constructor for SendEmailRequest object. Callers should use the setter or fluent setter (with...) methods * to initialize the object after creating it. */ public SendEmailRequest() { } /** * Constructs a new SendEmailRequest object. Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @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 local part of a source * email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain * part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded * using Punycode, as described in RFC3492. The sender * name (also known as the friendly name) may contain non-ASCII characters. These characters must be * encoded using MIME encoded-word syntax, as described in RFC * 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= * . *

* @param destination * The destination for this email, composed of To:, CC:, and BCC: fields. * @param message * The message to be sent. */ public SendEmailRequest(String source, Destination destination, Message message) { setSource(source); setDestination(destination); setMessage(message); } /** *

* *

* * * @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.

* *

*/ public void setSource(String source) { this.source = source; } /** *

* *

* * * @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.

* *

* Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a * source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the * domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be * encoded using Punycode, as described in RFC3492. * The sender name (also known as the friendly name) may contain non-ASCII characters. These * characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following * form: =?charset?encoding?encoded-text?=. *

*/ public String getSource() { return this.source; } /** *

* *

* @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest withSource(String source) { setSource(source); return this; } /** *

* The destination for this email, composed of To:, CC:, and BCC: fields. *

* * @param destination * The destination for this email, composed of To:, CC:, and BCC: fields. */ public void setDestination(Destination destination) { this.destination = destination; } /** *

* The destination for this email, composed of To:, CC:, and BCC: fields. *

* * @return The destination for this email, composed of To:, CC:, and BCC: fields. */ public Destination getDestination() { return this.destination; } /** *

* The destination for this email, composed of To:, CC:, and BCC: fields. *

* * @param destination * The destination for this email, composed of To:, CC:, and BCC: fields. * @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest withDestination(Destination destination) { setDestination(destination); return this; } /** *

* The message to be sent. *

* * @param message * The message to be sent. */ public void setMessage(Message message) { this.message = message; } /** *

* The message to be sent. *

* * @return The message to be sent. */ public Message getMessage() { return this.message; } /** *

* The message to be sent. *

* * @param message * The message to be sent. * @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest withMessage(Message message) { setMessage(message); return this; } /** *

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

* * @return 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.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 * will receive the reply. *

* * @param 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 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 * will receive 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 will receive the reply. * @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest 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 * will receive the reply. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest withReplyToAddresses(java.util.Collection replyToAddresses) { setReplyToAddresses(replyToAddresses); return this; } /** *

* * @param 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 setReturnPath(String returnPath) { this.returnPath = returnPath; } /** *

* * @return 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() { return this.returnPath; } /** *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest withReturnPath(String returnPath) { setReturnPath(returnPath); return this; } /** *

* 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 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(String sourceArn) { this.sourceArn = sourceArn; } /** *

* 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 more information about sending authorization, see the Amazon SES * Developer Guide. */ public String getSourceArn() { return this.sourceArn; } /** *

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

* 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 SendEmailRequest withSourceArn(String sourceArn) { setSourceArn(sourceArn); return this; } /** *

* 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 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(String returnPathArn) { this.returnPathArn = returnPathArn; } /** *

* 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 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() { return this.returnPathArn; } /** *

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

* 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 SendEmailRequest withReturnPathArn(String returnPathArn) { setReturnPathArn(returnPathArn); return this; } /** *

* * @return A list of tags, in the form of name/value pairs, to apply to an email that you send using * SendEmail. 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; } /** *

* * @param tags * A list of tags, in the form of name/value pairs, to apply to an email that you send using * SendEmail. 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); } /** *

* 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 * SendEmail. 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 SendEmailRequest 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; } /** *

* * @param tags * A list of tags, in the form of name/value pairs, to apply to an email that you send using * SendEmail. 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 SendEmailRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

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

* * @param configurationSetName * The name of the configuration set to use when you send an email using SendEmail. */ public void setConfigurationSetName(String configurationSetName) { this.configurationSetName = configurationSetName; } /** *

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

* * @return The name of the configuration set to use when you send an email using SendEmail. */ public String getConfigurationSetName() { return this.configurationSetName; } /** *

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

* * @param configurationSetName * The name of the configuration set to use when you send an email using SendEmail. * @return Returns a reference to this object so that method calls can be chained together. */ public SendEmailRequest withConfigurationSetName(String configurationSetName) { setConfigurationSetName(configurationSetName); 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 (getMessage() != null) sb.append("Message: ").append(getMessage()).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()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SendEmailRequest == false) return false; SendEmailRequest other = (SendEmailRequest) 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.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == 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; 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 + ((getMessage() == null) ? 0 : getMessage().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()); return hashCode; } @Override public SendEmailRequest clone() { return (SendEmailRequest) super.clone(); } }