org.simplejavamail.email

Class Recipient

java.lang.Object

org.simplejavamail.email.Recipient

public final class Recipient
extends Object

An immutable recipient object, with a name, emailaddress and recipient type (eg Message.RecipientType.BCC).

Author:

Benny Bottema

Constructor Summary

Constructors

Constructor and Description
Recipient(String name, String address, javax.mail.Message.RecipientType type) Constructor; initializes this recipient object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAddress() Bean getter for address;
String	getName() Bean getter for name;
javax.mail.Message.RecipientType	getType() Bean getter for type;
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Recipient

public Recipient(@Nullable
                 String name,
                 @Nonnull
                 String address,
                 @Nullable
                 javax.mail.Message.RecipientType type)

Constructor; initializes this recipient object.

Parameters:

name - The name of the recipient, optional in which just the address is shown.

address - The email address of the recipient.

type - The recipient type (eg. Message.RecipientType.TO), optional for from and replyTo fields.

See Also:

Message.RecipientType

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getName

@Nullable
public String getName()

Bean getter for name;

getAddress

@Nonnull
public String getAddress()

Bean getter for address;

getType

@Nullable
public javax.mail.Message.RecipientType getType()

Bean getter for type;