FileDocCategorySizeDatePackage
MessageCountEvent.javaAPI DocGlassfish v2 API5243Mon May 14 15:28:48 BST 2007javax.mail.event

MessageCountEvent

public class MessageCountEvent extends MailEvent
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.

author
John Mani

Fields Summary
public static final int
ADDED
The messages were added to their folder
public static final int
REMOVED
The messages were removed from their folder
protected int
type
The event type.
protected boolean
removed
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.
protected transient Message[]
msgs
The messages.
private static final long
serialVersionUID
Constructors Summary
public MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs)
Constructor.

param
folder The containing folder
param
type The event type
param
removed 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.
param
msgs The messages added/removed


         	    	    	         			         			       			         			    	       
         
			         
	super(folder);
	this.type = type;
	this.removed = removed;
	this.msgs = msgs;
Methods Summary
public voiddispatch(java.lang.Object listener)
Invokes the appropriate MessageCountListener method.

	if (type == ADDED)
	    ((MessageCountListener)listener).messagesAdded(this);
	else // REMOVED
	    ((MessageCountListener)listener).messagesRemoved(this);
public Message[]getMessages()
Return the array of messages added or removed.

return
array of messages

	return msgs;
public intgetType()
Return the type of this event.

return
type

	return type;
public booleanisRemoved()
Indicates whether this event is the result of an explicit expunge by this client, or due to an expunge from external sources. If 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

	return removed;