| Methods Summary |
|---|
| public synchronized void | addConnectionListener(javax.mail.event.ConnectionListener l)Add a listener for Connection events on this Folder.
The implementation provided here adds this listener
to an internal list of ConnectionListeners.
if (connectionListeners == null)
connectionListeners = new Vector();
connectionListeners.addElement(l);
|
| public synchronized void | addFolderListener(javax.mail.event.FolderListener l)Add a listener for Folder events on this Folder.
The implementation provided here adds this listener
to an internal list of FolderListeners.
if (folderListeners == null)
folderListeners = new Vector();
folderListeners.addElement(l);
|
| public synchronized void | addMessageChangedListener(javax.mail.event.MessageChangedListener l)Add a listener for MessageChanged events on this Folder.
The implementation provided here adds this listener
to an internal list of MessageChangedListeners.
if (messageChangedListeners == null)
messageChangedListeners = new Vector();
messageChangedListeners.addElement(l);
|
| public synchronized void | addMessageCountListener(javax.mail.event.MessageCountListener l)Add a listener for MessageCount events on this Folder.
The implementation provided here adds this listener
to an internal list of MessageCountListeners.
if (messageCountListeners == null)
messageCountListeners = new Vector();
messageCountListeners.addElement(l);
|
| public abstract void | appendMessages(Message[] msgs)Append given Messages to this folder. This method can be
invoked on a closed Folder. An appropriate MessageCountEvent
is delivered to any MessageCountListener registered on this
folder when the messages arrive in the folder.
Folder implementations must not abort this operation if a
Message in the given message array turns out to be an
expunged Message.
|
| public abstract void | close(boolean expunge)Close this Folder. This method is valid only on open Folders.
A CLOSED ConnectionEvent is delivered to any ConnectionListeners
registered on this Folder. Note that the folder is closed even
if this method terminates abnormally by throwing a
MessagingException.
|
| public void | copyMessages(Message[] msgs, javax.mail.Folder folder)Copy the specified Messages from this Folder into another
Folder. This operation appends these Messages to the
destination Folder. The destination Folder does not have to
be opened. An appropriate MessageCountEvent
is delivered to any MessageCountListener registered on the
destination folder when the messages arrive in the folder.
Note that the specified Message objects must
belong to this folder. Folder implementations might be able
to optimize this method by doing server-side copies.
This implementation just invokes appendMessages()
on the destination folder to append the given Messages. Specific
folder implementations that support server-side copies should
do so, if the destination folder's Store is the same as this
folder's Store.
Also, an implementation must not abort the operation if a
Message in the array turns out to be an expunged Message.
if (!folder.exists())
throw new FolderNotFoundException(
folder.getFullName() + " does not exist",
folder);
folder.appendMessages(msgs);
|
| public abstract boolean | create(int type)Create this folder on the Store. When this folder is created, any
folders in its path that do not exist are also created.
If the creation is successful, a CREATED FolderEvent is delivered
to any FolderListeners registered on this Folder and this Store.
|
| public abstract boolean | delete(boolean recurse)Delete this Folder. This method will succeed only on a closed
Folder.
The recurse flag controls whether the deletion affects
subfolders or not. If true, all subfolders are deleted, then this
folder itself is deleted. If false, the behaviour is dependent on
the folder type and is elaborated below:
|
| public abstract boolean | exists()Tests if this folder physically exists on the Store.
This method can be invoked on a closed Folder.
|
| public abstract Message[] | expunge()Expunge (permanently remove) messages marked DELETED. Returns an
array containing the expunged message objects. The
getMessageNumber method
on each of these message objects returns that Message's original
(that is, prior to the expunge) sequence number. A MessageCountEvent
containing the expunged messages is delivered to any
MessageCountListeners registered on the folder.
Expunge causes the renumbering of Message objects subsequent to
the expunged messages. Clients that use message numbers as
references to messages should be aware of this and should be
prepared to deal with the situation (probably by flushing out
existing message number caches and reloading them). Because of
this complexity, it is better for clients to use Message objects
as references to messages, rather than message numbers. Any
expunged Messages objects still have to be pruned, but other
Messages in that folder are not affected by the expunge.
After a message is expunged, only the isExpunged and
getMessageNumber methods are still valid on the
corresponding Message object; other methods may throw
MessageRemovedException
|
| public void | fetch(Message[] msgs, javax.mail.FetchProfile fp)Prefetch the items specified in the FetchProfile for the
given Messages.
Clients use this method to indicate that the specified items are
needed en-masse for the given message range. Implementations are
expected to retrieve these items for the given message range in
a efficient manner. Note that this method is just a hint to the
implementation to prefetch the desired items.
An example is a client filling its header-view window with
the Subject, From and X-mailer headers for all messages in the
folder.
Message[] msgs = folder.getMessages();
FetchProfile fp = new FetchProfile();
fp.add(FetchProfile.Item.ENVELOPE);
fp.add("X-mailer");
folder.fetch(msgs, fp);
for (int i = 0; i < folder.getMessageCount(); i++) {
display(msg[i].getFrom());
display(msg[i].getSubject());
display(msg[i].getHeader("X-mailer"));
}
The implementation provided here just returns without
doing anything useful. Providers wanting to provide a real
implementation for this method should override this method.
return;
|
| protected void | finalize()
super.finalize();
terminateQueue();
|
| public synchronized int | getDeletedMessageCount()Get the number of deleted messages in this Folder.
This method can be invoked on a closed folder. However, note
that for some folder implementations, getting the deleted message
count can be an expensive operation involving actually opening
the folder. In such cases, a provider can choose not to support
this functionality in the closed state, in which case this method
must return -1.
Clients invoking this method on a closed folder must be aware
that this is a potentially expensive operation. Clients must
also be prepared to handle a return value of -1 in this case.
This implementation returns -1 if this folder is closed. Else
this implementation gets each Message in the folder using
getMessage(int) and checks whether its
DELETED flag is set. The total number of messages
that have this flag set is returned.
if (!isOpen())
return -1;
int deleted = 0;
int total = getMessageCount();
for (int i = 1; i <= total; i++) {
try {
if (getMessage(i).isSet(Flags.Flag.DELETED))
deleted++;
} catch (MessageRemovedException me) {
// This is an expunged message, ignore it.
continue;
}
}
return deleted;
|
| public abstract javax.mail.Folder | getFolder(java.lang.String name)Return the Folder object corresponding to the given name. Note that
this folder does not physically have to exist in the Store. The
exists() method on a Folder indicates whether it really
exists on the Store.
In some Stores, name can be an absolute path if it starts with the
hierarchy delimiter. Otherwise, it is interpreted relative to
this Folder.
Folder objects are not cached by the Store, so invoking this
method on the same name multiple times will return that many
distinct Folder objects.
This method can be invoked on a closed Folder.
|
| public abstract java.lang.String | getFullName()Returns the full name of this Folder. If the folder resides under
the root hierarchy of this Store, the returned name is relative
to the root. Otherwise an absolute name, starting with the
hierarchy delimiter, is returned.
This method can be invoked on a closed Folder.
|
| public abstract Message | getMessage(int msgnum)Get the Message object corresponding to the given message
number. A Message object's message number is the relative
position of this Message in its Folder. Messages are numbered
starting at 1 through the total number of message in the folder.
Note that the message number for a particular Message can change
during a session if other messages in the Folder are deleted and
the Folder is expunged.
Message objects are light-weight references to the actual message
that get filled up on demand. Hence Folder implementations are
expected to provide light-weight Message objects.
Unlike Folder objects, repeated calls to getMessage with the
same message number will return the same Message object, as
long as no messages in this folder have been expunged.
Since message numbers can change within a session if the folder
is expunged , clients are advised not to use message numbers as
references to messages. Use Message objects instead.
|
| public abstract int | getMessageCount()Get total number of messages in this Folder.
This method can be invoked on a closed folder. However, note
that for some folder implementations, getting the total message
count can be an expensive operation involving actually opening
the folder. In such cases, a provider can choose not to support
this functionality in the closed state, in which case this method
must return -1.
Clients invoking this method on a closed folder must be aware
that this is a potentially expensive operation. Clients must
also be prepared to handle a return value of -1 in this case.
|
| public synchronized Message[] | getMessages(int start, int end)Get the Message objects for message numbers ranging from start
through end, both start and end inclusive. Note that message
numbers start at 1, not 0.
Message objects are light-weight references to the actual message
that get filled up on demand. Hence Folder implementations are
expected to provide light-weight Message objects.
This implementation uses getMessage(index) to obtain the required
Message objects. Note that the returned array must contain
(end-start+1) Message objects.
Message[] msgs = new Message[end - start +1];
for (int i = start; i <= end; i++)
msgs[i - start] = getMessage(i);
return msgs;
|
| public synchronized Message[] | getMessages(int[] msgnums)Get the Message objects for message numbers specified in
the array.
Message objects are light-weight references to the actual message
that get filled up on demand. Hence Folder implementations are
expected to provide light-weight Message objects.
This implementation uses getMessage(index) to obtain the required
Message objects. Note that the returned array must contain
msgnums.length Message objects
int len = msgnums.length;
Message[] msgs = new Message[len];
for (int i = 0; i < len; i++)
msgs[i] = getMessage(msgnums[i]);
return msgs;
|
| public synchronized Message[] | getMessages()Get all Message objects from this Folder. Returns an empty array
if the folder is empty.
Clients can use Message objects (instead of sequence numbers)
as references to the messages within a folder; this method supplies
the Message objects to the client. Folder implementations are
expected to provide light-weight Message objects, which get
filled on demand.
This implementation invokes getMessageCount() to get
the current message count and then uses getMessage()
to get Message objects from 1 till the message count.
if (!isOpen()) // otherwise getMessageCount might return -1
throw new IllegalStateException("Folder not open");
int total = getMessageCount();
Message[] msgs = new Message[total];
for (int i = 1; i <= total; i++)
msgs[i-1] = getMessage(i);
return msgs;
|
| public int | getMode()Return the open mode of this folder. Returns
Folder.READ_ONLY, Folder.READ_WRITE,
or -1 if the open mode is not known (usually only because an older
Folder provider has not been updated to use this new
method).
if (!isOpen())
throw new IllegalStateException("Folder not open");
return mode;
|
| public abstract java.lang.String | getName()Returns the name of this Folder.
This method can be invoked on a closed Folder.
|
| public synchronized int | getNewMessageCount()Get the number of new messages in this Folder.
This method can be invoked on a closed folder. However, note
that for some folder implementations, getting the new message
count can be an expensive operation involving actually opening
the folder. In such cases, a provider can choose not to support
this functionality in the closed state, in which case this method
must return -1.
Clients invoking this method on a closed folder must be aware
that this is a potentially expensive operation. Clients must
also be prepared to handle a return value of -1 in this case.
This implementation returns -1 if this folder is closed. Else
this implementation gets each Message in the folder using
getMessage(int) and checks whether its
RECENT flag is set. The total number of messages
that have this flag set is returned.
if (!isOpen())
return -1;
int newmsgs = 0;
int total = getMessageCount();
for (int i = 1; i <= total; i++) {
try {
if (getMessage(i).isSet(Flags.Flag.RECENT))
newmsgs++;
} catch (MessageRemovedException me) {
// This is an expunged message, ignore it.
continue;
}
}
return newmsgs;
|
| public abstract javax.mail.Folder | getParent()Returns the parent folder of this folder.
This method can be invoked on a closed Folder. If this folder
is the top of a folder hierarchy, this method returns null.
Note that since Folder objects are not cached, invoking this method
returns a new distinct Folder object.
|
| public abstract javax.mail.Flags | getPermanentFlags()Get the permanent flags supported by this Folder. Returns a Flags
object that contains all the flags supported.
The special flag Flags.USER indicates that this Folder
supports arbitrary user-defined flags.
The supported permanent flags for a folder may not be available
until the folder is opened.
|
| public abstract char | getSeparator()Return the delimiter character that separates this Folder's pathname
from the names of immediate subfolders. This method can be invoked
on a closed Folder.
|
| public javax.mail.Store | getStore()Returns the Store that owns this Folder object.
This method can be invoked on a closed Folder.
return store;
|
| public abstract int | getType()Returns the type of this Folder, that is, whether this folder can hold
messages or subfolders or both. The returned value is an integer
bitfield with the appropriate bits set. This method can be invoked
on a closed folder.
|
| public javax.mail.URLName | getURLName()Return a URLName representing this folder. The returned URLName
does not include the password used to access the store.
URLName storeURL = getStore().getURLName();
String fullname = getFullName();
StringBuffer encodedName = new StringBuffer();
if (fullname != null) {
/*
// We need to encode each of the folder's names.
char separator = getSeparator();
StringTokenizer tok = new StringTokenizer(
fullname, new Character(separator).toString(), true);
while (tok.hasMoreTokens()) {
String s = tok.nextToken();
if (s.charAt(0) == separator)
encodedName.append(separator);
else
// XXX - should encode, but since there's no decoder...
//encodedName.append(java.net.URLEncoder.encode(s));
encodedName.append(s);
}
*/
// append the whole thing, until we can encode
encodedName.append(fullname);
}
/*
* Sure would be convenient if URLName had a
* constructor that took a base URLName.
*/
return new URLName(storeURL.getProtocol(), storeURL.getHost(),
storeURL.getPort(), encodedName.toString(),
storeURL.getUsername(),
null /* no password */);
|
| public synchronized int | getUnreadMessageCount()Get the total number of unread messages in this Folder.
This method can be invoked on a closed folder. However, note
that for some folder implementations, getting the unread message
count can be an expensive operation involving actually opening
the folder. In such cases, a provider can choose not to support
this functionality in the closed state, in which case this method
must return -1.
Clients invoking this method on a closed folder must be aware
that this is a potentially expensive operation. Clients must
also be prepared to handle a return value of -1 in this case.
This implementation returns -1 if this folder is closed. Else
this implementation gets each Message in the folder using
getMessage(int) and checks whether its
SEEN flag is set. The total number of messages
that do not have this flag set is returned.
if (!isOpen())
return -1;
int unread = 0;
int total = getMessageCount();
for (int i = 1; i <= total; i++) {
try {
if (!getMessage(i).isSet(Flags.Flag.SEEN))
unread++;
} catch (MessageRemovedException me) {
// This is an expunged message, ignore it.
continue;
}
}
return unread;
|
| public abstract boolean | hasNewMessages()Returns true if this Folder has new messages since the last time
this indication was reset. When this indication is set or reset
depends on the Folder implementation (and in the case of IMAP,
depends on the server). This method can be used to implement
a lightweight "check for new mail" operation on a Folder without
opening it. (For example, a thread that monitors a mailbox and
flags when it has new mail.) This method should indicate whether
any messages in the Folder have the RECENT flag set.
Note that this is not an incremental check for new mail, i.e.,
it cannot be used to determine whether any new messages have
arrived since the last time this method was invoked. To
implement incremental checks, the Folder needs to be opened.
This method can be invoked on a closed Folder that can contain
Messages.
|
| public abstract boolean | isOpen()Indicates whether this Folder is in the 'open' state.
|
| public boolean | isSubscribed()Returns true if this Folder is subscribed.
This method can be invoked on a closed Folder.
The default implementation provided here just returns true.
return true;
|
| public javax.mail.Folder[] | list()Convenience method that returns the list of folders under this
Folder. This method just calls the list(String pattern)
method with "%" as the match pattern. This method can
be invoked on a closed Folder.
return list("%");
|
| public abstract javax.mail.Folder[] | list(java.lang.String pattern)Returns a list of Folders belonging to this Folder's namespace
that match the specified pattern. Patterns may contain the wildcard
characters "%", which matches any character except hierarchy
delimiters, and "*", which matches any character.
As an example, given the folder hierarchy:
Personal/
Finance/
Stocks
Bonus
StockOptions
Jokes
list("*") on "Personal" will return the whole
hierarchy.
list("%") on "Personal" will return "Finance" and
"Jokes".
list("Jokes") on "Personal" will return "Jokes".
list("Stock*") on "Finance" will return "Stocks"
and "StockOptions".
Folder objects are not cached by the Store, so invoking this
method on the same pattern multiple times will return that many
distinct Folder objects.
This method can be invoked on a closed Folder.
|
| public javax.mail.Folder[] | listSubscribed()Convenience method that returns the list of subscribed folders
under this Folder. This method just calls the
listSubscribed(String pattern) method with "%"
as the match pattern. This method can be invoked on a closed Folder.
return listSubscribed("%");
|
| public javax.mail.Folder[] | listSubscribed(java.lang.String pattern)Returns a list of subscribed Folders belonging to this Folder's
namespace that match the specified pattern. If the folder does
not support subscription, this method should resolve to
list.
(The default implementation provided here, does just this).
The pattern can contain wildcards as for list.
Note that, at a given level of the folder hierarchy, a particular
folder may not be subscribed, but folders underneath that folder
in the folder hierarchy may be subscribed. In order to allow
walking the folder hierarchy, such unsubscribed folders may be
returned, indicating that a folder lower in the hierarchy is
subscribed. The isSubscribed method on a folder will
tell whether any particular folder is actually subscribed.
Folder objects are not cached by the Store, so invoking this
method on the same pattern multiple times will return that many
distinct Folder objects.
This method can be invoked on a closed Folder.
return list(pattern);
|
| protected void | notifyConnectionListeners(int type)Notify all ConnectionListeners. Folder implementations are
expected to use this method to broadcast connection events.
The provided implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the registered
ConnectionListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
if (connectionListeners != null) {
ConnectionEvent e = new ConnectionEvent(this, type);
queueEvent(e, connectionListeners);
}
/* Fix for broken JDK1.1.x Garbage collector :
* The 'conservative' GC in JDK1.1.x occasionally fails to
* garbage-collect Threads which are in the wait state.
* This would result in thread (and consequently memory) leaks.
*
* We attempt to fix this by sending a 'terminator' event
* to the queue, after we've sent the CLOSED event. The
* terminator event causes the event-dispatching thread to
* self destruct.
*/
if (type == ConnectionEvent.CLOSED)
terminateQueue();
|
| protected void | notifyFolderListeners(int type)Notify all FolderListeners registered on this Folder and
this folder's Store. Folder implementations are expected
to use this method to broadcast Folder events.
The implementation provided here queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the
FolderListeners registered on this folder. The implementation
also invokes notifyFolderListeners on this folder's
Store to notify any FolderListeners registered on the store.
if (folderListeners != null) {
FolderEvent e = new FolderEvent(this, this, type);
queueEvent(e, folderListeners);
}
store.notifyFolderListeners(type, this);
|
| protected void | notifyFolderRenamedListeners(javax.mail.Folder folder)Notify all FolderListeners registered on this Folder and
this folder's Store about the renaming of this folder.
Folder implementations are expected to use this method to
broadcast Folder events indicating the renaming of folders.
The implementation provided here queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the
FolderListeners registered on this folder. The implementation
also invokes notifyFolderRenamedListeners on this
folder's Store to notify any FolderListeners registered on the store.
if (folderListeners != null) {
FolderEvent e = new FolderEvent(this, this, folder,
FolderEvent.RENAMED);
queueEvent(e, folderListeners);
}
store.notifyFolderRenamedListeners(this, folder);
|
| protected void | notifyMessageAddedListeners(Message[] msgs)Notify all MessageCountListeners about the addition of messages
into this folder. Folder implementations are expected to use this
method to broadcast MessageCount events for indicating arrival of
new messages.
The provided implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the registered
MessageCountListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
if (messageCountListeners == null)
return;
MessageCountEvent e = new MessageCountEvent(
this,
MessageCountEvent.ADDED,
false,
msgs);
queueEvent(e, messageCountListeners);
|
| protected void | notifyMessageChangedListeners(int type, Message msg)Notify all MessageChangedListeners. Folder implementations are
expected to use this method to broadcast MessageChanged events.
The provided implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to registered
MessageChangedListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
if (messageChangedListeners == null)
return;
MessageChangedEvent e = new MessageChangedEvent(this, type, msg);
queueEvent(e, messageChangedListeners);
|
| protected void | notifyMessageRemovedListeners(boolean removed, Message[] msgs)Notify all MessageCountListeners about the removal of messages
from this Folder. Folder implementations are expected to use this
method to broadcast MessageCount events indicating removal of
messages.
The provided implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the registered
MessageCountListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
if (messageCountListeners == null)
return;
MessageCountEvent e = new MessageCountEvent(
this,
MessageCountEvent.REMOVED,
removed,
msgs);
queueEvent(e, messageCountListeners);
|
| public abstract void | open(int mode)Open this Folder. This method is valid only on Folders that
can contain Messages and that are closed.
If this folder is opened successfully, an OPENED ConnectionEvent
is delivered to any ConnectionListeners registered on this
Folder.
The effect of opening multiple connections to the same folder
on a specifc Store is implementation dependent. Some implementations
allow multiple readers, but only one writer. Others allow
multiple writers as well as readers.
|
| private void | queueEvent(javax.mail.event.MailEvent event, java.util.Vector vector)
/*
* Add the event and vector of listeners to the queue to be delivered.
*/
// synchronize creation of the event queue
synchronized (qLock) {
if (q == null)
q = new EventQueue();
}
/*
* Copy the vector in order to freeze the state of the set
* of EventListeners the event should be delivered to prior
* to delivery. This ensures that any changes made to the
* Vector from a target listener's method during the delivery
* of this event will not take effect until after the event is
* delivered.
*/
Vector v = (Vector)vector.clone();
q.enqueue(event, v);
|
| public synchronized void | removeConnectionListener(javax.mail.event.ConnectionListener l)Remove a Connection event listener.
The implementation provided here removes this listener
from the internal list of ConnectionListeners.
if (connectionListeners != null)
connectionListeners.removeElement(l);
|
| public synchronized void | removeFolderListener(javax.mail.event.FolderListener l)Remove a Folder event listener.
The implementation provided here removes this listener
from the internal list of FolderListeners.
if (folderListeners != null)
folderListeners.removeElement(l);
|
| public synchronized void | removeMessageChangedListener(javax.mail.event.MessageChangedListener l)Remove a MessageChanged listener.
The implementation provided here removes this listener
from the internal list of MessageChangedListeners.
if (messageChangedListeners != null)
messageChangedListeners.removeElement(l);
|
| public synchronized void | removeMessageCountListener(javax.mail.event.MessageCountListener l)Remove a MessageCount listener.
The implementation provided here removes this listener
from the internal list of MessageCountListeners.
if (messageCountListeners != null)
messageCountListeners.removeElement(l);
|
| public abstract boolean | renameTo(javax.mail.Folder f)Rename this Folder. This method will succeed only on a closed
Folder.
If the rename is successful, a RENAMED FolderEvent is delivered
to FolderListeners registered on this folder and its containing
Store.
|
| public Message[] | search(javax.mail.search.SearchTerm term)Search this Folder for messages matching the specified
search criterion. Returns an array containing the matching
messages . Returns an empty array if no matches were found.
This implementation invokes
search(term, getMessages()), to apply the search
over all the messages in this folder. Providers that can implement
server-side searching might want to override this method to provide
a more efficient implementation.
return search(term, getMessages());
|
| public Message[] | search(javax.mail.search.SearchTerm term, Message[] msgs)Search the given array of messages for those that match the
specified search criterion. Returns an array containing the
matching messages. Returns an empty array if no matches were
found.
Note that the specified Message objects must
belong to this folder.
This implementation iterates through the given array of messages,
and applies the search criterion on each message by calling
its match() method with the given term. The
messages that succeed in the match are returned. Providers
that can implement server-side searching might want to override
this method to provide a more efficient implementation. If the
search term is too complex or contains user-defined terms that
cannot be executed on the server, providers may elect to either
throw a SearchException or degenerate to client-side searching by
calling super.search() to invoke this implementation.
Vector matchedMsgs = new Vector();
// Run thru the given messages
for (int i = 0; i < msgs.length; i++) {
try {
if (msgs[i].match(term)) // matched
matchedMsgs.addElement(msgs[i]); // add it
} catch(MessageRemovedException mrex) { }
}
Message[] m = new Message[matchedMsgs.size()];
matchedMsgs.copyInto(m);
return m;
|
| public synchronized void | setFlags(Message[] msgs, javax.mail.Flags flag, boolean value)Set the specified flags on the messages specified in the array.
This will result in appropriate MessageChangedEvents being
delivered to any MessageChangedListener registered on this
Message's containing folder.
Note that the specified Message objects must
belong to this folder. Certain Folder implementations can
optimize the operation of setting Flags for a group of messages,
so clients might want to use this method, rather than invoking
Message.setFlags for each Message.
This implementation degenerates to invoking setFlags()
on each Message object. Specific Folder implementations that can
optimize this case should do so.
Also, an implementation must not abort the operation if a Message
in the array turns out to be an expunged Message.
for (int i = 0; i < msgs.length; i++) {
try {
msgs[i].setFlags(flag, value);
} catch (MessageRemovedException me) {
// This message is expunged, skip
}
}
|
| public synchronized void | setFlags(int start, int end, javax.mail.Flags flag, boolean value)Set the specified flags on the messages numbered from start
through end, both start and end inclusive. Note that message
numbers start at 1, not 0.
This will result in appropriate MessageChangedEvents being
delivered to any MessageChangedListener registered on this
Message's containing folder.
Certain Folder implementations can
optimize the operation of setting Flags for a group of messages,
so clients might want to use this method, rather than invoking
Message.setFlags for each Message.
The default implementation uses getMessage(int) to
get each Message object and then invokes
setFlags on that object to set the flags.
Specific Folder implementations that can optimize this case should do so.
Also, an implementation must not abort the operation if a message
number refers to an expunged message.
for (int i = start; i <= end; i++) {
try {
Message msg = getMessage(i);
msg.setFlags(flag, value);
} catch (MessageRemovedException me) {
// This message is expunged, skip
}
}
|
| public synchronized void | setFlags(int[] msgnums, javax.mail.Flags flag, boolean value)Set the specified flags on the messages whose message numbers
are in the array.
This will result in appropriate MessageChangedEvents being
delivered to any MessageChangedListener registered on this
Message's containing folder.
Certain Folder implementations can
optimize the operation of setting Flags for a group of messages,
so clients might want to use this method, rather than invoking
Message.setFlags for each Message.
The default implementation uses getMessage(int) to
get each Message object and then invokes
setFlags on that object to set the flags.
Specific Folder implementations that can optimize this case should do so.
Also, an implementation must not abort the operation if a message
number refers to an expunged message.
for (int i = 0; i < msgnums.length; i++) {
try {
Message msg = getMessage(msgnums[i]);
msg.setFlags(flag, value);
} catch (MessageRemovedException me) {
// This message is expunged, skip
}
}
|
| public void | setSubscribed(boolean subscribe)Subscribe or unsubscribe this Folder. Not all Stores support
subscription.
This method can be invoked on a closed Folder.
The implementation provided here just throws the
MethodNotSupportedException.
throw new MethodNotSupportedException();
|
| private void | terminateQueue()
synchronized (qLock) {
if (q != null) {
Vector dummyListeners = new Vector();
dummyListeners.setSize(1); // need atleast one listener
q.enqueue(new TerminatorEvent(), dummyListeners);
q = null;
}
}
|
| public java.lang.String | toString()override the default toString(), it will return the String
from Folder.getFullName() or if that is null, it will use
the default toString() behavior.
String s = getFullName();
if (s != null)
return s;
else
return super.toString();
|
