Message.RecipientType (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail
Class Message.RecipientType

java.lang.Object
  javax.mail.Message.RecipientType

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: MimeMessage.RecipientType

Enclosing class:: Message

public static class Message.RecipientType
extends Object
implements Serializable
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(javax.mail.Message.RecipientType), Message.setRecipients(javax.mail.Message.RecipientType, javax.mail.Address[]), Message.addRecipients(javax.mail.Message.RecipientType, javax.mail.Address[]), Serialized Form

Field Summary

static Message.RecipientType BCC
          The "Bcc" (blind carbon copy) recipients.

static Message.RecipientType CC
          The "Cc" (carbon copy) recipients.

static 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

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

Method Summary

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 Summary
`static Message.RecipientType`	`BCC` The "Bcc" (blind carbon copy) recipients.
`static Message.RecipientType`	`CC` The "Cc" (carbon copy) recipients.
`static 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
`protected`	`Message.RecipientType(String type)` Constructor for use by subclasses.

Method Summary
`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 Detail

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 Detail