Class MailEvent

  extended byjava.util.EventObject
All Implemented Interfaces:
Direct Known Subclasses:
FolderEvent, MessageCountEvent, MessageFlagEvent

public abstract class MailEvent
extends java.util.EventObject

Generic mail event.

Mail events are generated by mail folders to inform the rest of the application about the particular folder or message modifications. It can be used to implement a simultaneous access to mail folders as well as protocols that require an unsolicited response model, such as IMAP.

See Also:
Serialized Form

Field Summary
protected  int type
          The mail event type.
protected  java.lang.String user
          The user who produced this event.
Fields inherited from class java.util.EventObject
Constructor Summary
MailEvent(MailFolder source, java.lang.String user, int type)
          Creates a new MailEvent.
Method Summary
 MailFolder getSourceFolder()
          Returns the source folder.
 int getType()
          Returns the event type.
 java.lang.String getUser()
          Returns the user producing the event.
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


protected final int type
The mail event type.


protected final java.lang.String user
The user who produced this event.

Constructor Detail


public MailEvent(MailFolder source,
                 java.lang.String user,
                 int type)
Creates a new MailEvent.

Mail events are always associated with a source folder and user who produced them. In other words, the folders generate mail events according to operations performed on them by the particular users.

source - the source folder
user - the user producing this event
type - the event type
Method Detail


public MailFolder getSourceFolder()
Returns the source folder.

the source folder of this event


public java.lang.String getUser()
Returns the user producing the event.

the user


public int getType()
Returns the event type.

the type

Copyright (c) 2004-2005, Gnome Ltd. All rights reserved.