javax.mail
Class Message.RecipientType

java.lang.Object
  extended by javax.mail.Message.RecipientType
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
MimeMessage.RecipientType
Enclosing class:
Message

public static class Message.RecipientType
extends java.lang.Object
implements java.io.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  java.lang.String type
          The type of recipient, usually the name of a corresponding Internet standard header.
 
Constructor Summary
protected Message.RecipientType(java.lang.String type)
          Constructor for use by subclasses.
 
Method Summary
protected  java.lang.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.
 java.lang.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 java.lang.String type
The type of recipient, usually the name of a corresponding Internet standard header.

Constructor Detail

Message.RecipientType

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

Method Detail

readResolve

protected java.lang.Object readResolve()
                                throws java.io.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.

Throws:
java.io.ObjectStreamException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Submit a bug or feature

Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.

Generated on 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter