org.codemonkey.simplejavamail.email.Recipient Maven / Gradle / Ivy

Go to download
package org.codemonkey.simplejavamail.email;

import javax.mail.Message.RecipientType;

/**
 * An immutable recipient object, with a name, emailaddress and recipient type (eg {@link RecipientType#BCC}).
 * 
 * @author Benny Bottema
 */
public final class Recipient {

	private final String name;

	private final String address;

	private final RecipientType type;

	/**
	 * Constructor; initializes this recipient object.
	 * 
	 * @param name The name of the recipient.
	 * @param address The email address of the recipient.
	 * @param type The recipient type (eg. {@link RecipientType#TO}).
	 * @see RecipientType
	 */
	public Recipient(final String name, final String address, final RecipientType type) {
		this.name = name;
		this.address = address;
		this.type = type;
	}

	@Override public String toString() {
		return "Recipient{" +
				"name='" + name + '\'' +
				", address='" + address + '\'' +
				", type=" + type +
				'}';
	}

	/**
	 * Bean getter for {@link #name};
	 */
	public String getName() {
		return name;
	}

	/**
	 * Bean getter for {@link #address};
	 */
	public String getAddress() {
		return address;
	}

	/**
	 * Bean getter for {@link #type};
	 */
	public RecipientType getType() {
		return type;
	}
}