Module jakarta.mail

Package jakarta.mail

Class Message.RecipientType

java.lang.Object

jakarta.mail.Message.RecipientType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MimeMessage.RecipientType

Enclosing class:

Message

public static class Message.RecipientType
extends Object
implements Serializable

This inner class defines the types of recipients allowed by the Message class. The currently defined types are TO, CC and BCC. Note that this class only has a protected constructor, thereby restricting new Recipient types to either this class or subclasses. This effectively implements an enumeration of the allowed Recipient types. The following code sample shows how to use this class to obtain the "TO" recipients from a message.

 Message msg = folder.getMessages(1);
 Address[] a = m.getRecipients(Message.RecipientType.TO);

 

See Also:

• Message.getRecipients(jakarta.mail.Message.RecipientType)
• Message.setRecipients(jakarta.mail.Message.RecipientType, jakarta.mail.Address[])
• Message.addRecipients(jakarta.mail.Message.RecipientType, jakarta.mail.Address[])
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Message.RecipientType	BCC	The "Bcc" (blind carbon copy) recipients.
static final Message.RecipientType	CC	The "Cc" (carbon copy) recipients.
static final Message.RecipientType	TO	The "To" (primary) recipients.
protected String	type	The type of recipient, usually the name of a corresponding Internet standard header.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RecipientType(String type)	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
protected Object	readResolve()	When deserializing a RecipientType, we need to make sure to return only one of the known static final instances defined in this class.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TO

public static final Message.RecipientType TO

The "To" (primary) recipients.

CC

public static final Message.RecipientType CC

The "Cc" (carbon copy) recipients.

BCC

public static final Message.RecipientType BCC

The "Bcc" (blind carbon copy) recipients.

type

protected String type

The type of recipient, usually the name of a corresponding Internet standard header.

Constructor Details

RecipientType

protected RecipientType(String type)

Constructor for use by subclasses.

Parameters:

type - the recipient type

Method Details

readResolve

protected Object readResolve()
                      throws ObjectStreamException

When deserializing a RecipientType, we need to make sure to return only one of the known static final instances defined in this class. Subclasses must implement their own readResolve method that checks for their known instances before calling this super method.

Returns:

the RecipientType object instance

Throws:

ObjectStreamException - for object stream errors

toString

public String toString()

Overrides:

toString in class Object