public class MessageCountEvent extends MailEvent
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 3501
for details.
A client may want to "poll" the folder by occasionally calling the
getMessageCount
or
isOpen
methods
to solicit any such notifications.
Modifier and Type | Field and Description |
---|---|
static int |
ADDED
The messages were added to their folder
|
protected Message[] |
msgs
The messages.
|
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.
|
static int |
REMOVED
The messages were removed from their folder
|
protected int |
type
The event type.
|
source
Constructor and Description |
---|
MessageCountEvent(Folder folder,
int type,
boolean removed,
Message[] msgs)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
dispatch(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.
|
getSource, toString
public static final int ADDED
public static final int REMOVED
protected int type
protected boolean removed
protected transient Message[] msgs
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/removedpublic 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()
Copyright © 2017 JBoss by Red Hat. All rights reserved.