org.simplejavamail.api.email

Class Recipient

java.lang.Object

org.simplejavamail.api.email.Recipient

All Implemented Interfaces:

Serializable

public final class Recipient
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Recipient

public Recipient(@Nullable
                 @Nullable String name,
                 @NotNull
                 @NotNull String address,
                 @Nullable
                 @Nullable jakarta.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 (e.g. Message.RecipientType.TO), optional for from and replyTo fields.

See Also:

Message.RecipientType

Method Detail

equals

public boolean equals(@Nullable
                      @Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

getName

@Nullable
public @Nullable String getName()

Bean getter for name;

getAddress

@NotNull
public @NotNull String getAddress()

Bean getter for address;

getType

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

Bean getter for type;