com.amazonaws.services.simpleemail.model.Destination 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;
/**
*
* Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
*
*
*
* 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.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Destination implements Serializable, Cloneable {
/**
*
* The recipients to place on the To: line of the message.
*
*/
private com.amazonaws.internal.SdkInternalList toAddresses;
/**
*
* The recipients to place on the CC: line of the message.
*
*/
private com.amazonaws.internal.SdkInternalList ccAddresses;
/**
*
* The recipients to place on the BCC: line of the message.
*
*/
private com.amazonaws.internal.SdkInternalList bccAddresses;
/**
* Default constructor for Destination object. Callers should use the setter or fluent setter (with...) methods to
* initialize the object after creating it.
*/
public Destination() {
}
/**
* Constructs a new Destination object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param toAddresses
* The recipients to place on the To: line of the message.
*/
public Destination(java.util.List toAddresses) {
setToAddresses(toAddresses);
}
/**
*
* The recipients to place on the To: line of the message.
*
*
* @return The recipients to place on the To: line of the message.
*/
public java.util.List getToAddresses() {
if (toAddresses == null) {
toAddresses = new com.amazonaws.internal.SdkInternalList();
}
return toAddresses;
}
/**
*
* The recipients to place on the To: line of the message.
*
*
* @param toAddresses
* The recipients to place on the To: line of the message.
*/
public void setToAddresses(java.util.Collection toAddresses) {
if (toAddresses == null) {
this.toAddresses = null;
return;
}
this.toAddresses = new com.amazonaws.internal.SdkInternalList(toAddresses);
}
/**
*
* The recipients to place on the To: line of the message.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setToAddresses(java.util.Collection)} or {@link #withToAddresses(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param toAddresses
* The recipients to place on the To: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Destination withToAddresses(String... toAddresses) {
if (this.toAddresses == null) {
setToAddresses(new com.amazonaws.internal.SdkInternalList(toAddresses.length));
}
for (String ele : toAddresses) {
this.toAddresses.add(ele);
}
return this;
}
/**
*
* The recipients to place on the To: line of the message.
*
*
* @param toAddresses
* The recipients to place on the To: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Destination withToAddresses(java.util.Collection toAddresses) {
setToAddresses(toAddresses);
return this;
}
/**
*
* The recipients to place on the CC: line of the message.
*
*
* @return The recipients to place on the CC: line of the message.
*/
public java.util.List getCcAddresses() {
if (ccAddresses == null) {
ccAddresses = new com.amazonaws.internal.SdkInternalList();
}
return ccAddresses;
}
/**
*
* The recipients to place on the CC: line of the message.
*
*
* @param ccAddresses
* The recipients to place on the CC: line of the message.
*/
public void setCcAddresses(java.util.Collection ccAddresses) {
if (ccAddresses == null) {
this.ccAddresses = null;
return;
}
this.ccAddresses = new com.amazonaws.internal.SdkInternalList(ccAddresses);
}
/**
*
* The recipients to place on the CC: line of the message.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCcAddresses(java.util.Collection)} or {@link #withCcAddresses(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param ccAddresses
* The recipients to place on the CC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Destination withCcAddresses(String... ccAddresses) {
if (this.ccAddresses == null) {
setCcAddresses(new com.amazonaws.internal.SdkInternalList(ccAddresses.length));
}
for (String ele : ccAddresses) {
this.ccAddresses.add(ele);
}
return this;
}
/**
*
* The recipients to place on the CC: line of the message.
*
*
* @param ccAddresses
* The recipients to place on the CC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Destination withCcAddresses(java.util.Collection ccAddresses) {
setCcAddresses(ccAddresses);
return this;
}
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* @return The recipients to place on the BCC: line of the message.
*/
public java.util.List getBccAddresses() {
if (bccAddresses == null) {
bccAddresses = new com.amazonaws.internal.SdkInternalList();
}
return bccAddresses;
}
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* @param bccAddresses
* The recipients to place on the BCC: line of the message.
*/
public void setBccAddresses(java.util.Collection bccAddresses) {
if (bccAddresses == null) {
this.bccAddresses = null;
return;
}
this.bccAddresses = new com.amazonaws.internal.SdkInternalList(bccAddresses);
}
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setBccAddresses(java.util.Collection)} or {@link #withBccAddresses(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param bccAddresses
* The recipients to place on the BCC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Destination withBccAddresses(String... bccAddresses) {
if (this.bccAddresses == null) {
setBccAddresses(new com.amazonaws.internal.SdkInternalList(bccAddresses.length));
}
for (String ele : bccAddresses) {
this.bccAddresses.add(ele);
}
return this;
}
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* @param bccAddresses
* The recipients to place on the BCC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Destination withBccAddresses(java.util.Collection bccAddresses) {
setBccAddresses(bccAddresses);
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 (getToAddresses() != null)
sb.append("ToAddresses: ").append(getToAddresses()).append(",");
if (getCcAddresses() != null)
sb.append("CcAddresses: ").append(getCcAddresses()).append(",");
if (getBccAddresses() != null)
sb.append("BccAddresses: ").append(getBccAddresses());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Destination == false)
return false;
Destination other = (Destination) obj;
if (other.getToAddresses() == null ^ this.getToAddresses() == null)
return false;
if (other.getToAddresses() != null && other.getToAddresses().equals(this.getToAddresses()) == false)
return false;
if (other.getCcAddresses() == null ^ this.getCcAddresses() == null)
return false;
if (other.getCcAddresses() != null && other.getCcAddresses().equals(this.getCcAddresses()) == false)
return false;
if (other.getBccAddresses() == null ^ this.getBccAddresses() == null)
return false;
if (other.getBccAddresses() != null && other.getBccAddresses().equals(this.getBccAddresses()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getToAddresses() == null) ? 0 : getToAddresses().hashCode());
hashCode = prime * hashCode + ((getCcAddresses() == null) ? 0 : getCcAddresses().hashCode());
hashCode = prime * hashCode + ((getBccAddresses() == null) ? 0 : getBccAddresses().hashCode());
return hashCode;
}
@Override
public Destination clone() {
try {
return (Destination) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}