| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.EventObject
javax.mail.event.MailEvent
javax.mail.event.MessageCountEvent
This class notifies changes in the number of messages in a folder.
 Note that some folder types may only deliver MessageCountEvents at
 certain times or after certain operations.  IMAP in particular will
 only notify the client of MessageCountEvents when a client issues a
 new command.
 Refer to RFC 2060 
 http://www.ietf.org/rfc/rfc2060.txt for details.
 A client may want "poll" the folder by occasionally calling the
 getMessageCount or isConnected methods
 to solicit any such notifications.
| Field Summary | |
| static int | ADDEDThe messages were added to their folder | 
| protected  Message[] | msgsThe messages. | 
| protected  boolean | removedIf true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this. | 
| static int | REMOVEDThe messages were removed from their folder | 
| protected  int | typeThe event type. | 
| Fields inherited from class java.util.EventObject | 
| source | 
| Constructor Summary | |
| MessageCountEvent(Folder folder,
                  int type,
                  boolean removed,
                  Message[] msgs)Constructor. | |
| Method Summary | |
|  void | dispatch(java.lang.Object listener)Invokes the appropriate MessageCountListener method. | 
|  Message[] | getMessages()Return the array of messages added or removed. | 
|  int | getType()Return the type of this event. | 
|  boolean | isRemoved()Indicates whether this event is the result of an explicit expunge by this client, or due to an expunge from external sources. | 
| Methods inherited from class java.util.EventObject | 
| getSource, toString | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
public static final int ADDED
public static final int REMOVED
protected int type
protected boolean removed
protected transient Message[] msgs
| Constructor Detail | 
public MessageCountEvent(Folder folder,
                         int type,
                         boolean removed,
                         Message[] msgs)
folder - The containing foldertype - The event typeremoved - If true, this event is the result of an explicit
			expunge by this client, and the messages in this 
			folder have been renumbered to account for this.
			If false, this event is the result of an expunge
			by external sources.msgs - The messages added/removed| Method Detail | 
public int getType()
public boolean isRemoved()
true, this event is due to an
 explicit expunge and hence all remaining messages in this
 folder have been renumbered. If false, this event
 is due to an external expunge. 
 Note that this method is valid only if the type of this event
 is REMOVED
public Message[] getMessages()
public void dispatch(java.lang.Object listener)
dispatch in class MailEvent| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.