The "root" folder of the NNTP newsgroup list.
The NNTP folder namespace is taken to be a flat namespace.
This object allows us to retrieve folders corresponding to each newsgroup
in that space.
close
public void close(boolean expunge)
throws MessagingException
Closes this folder.
This method can only be invoked on an open folder.
- close in interface Folder
expunge
- if true, expunge all deleted messages
create
public boolean create(int type)
throws MessagingException
Create this folder in 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.
- create in interface Folder
type
- the desired type of the folder
delete
public boolean delete(boolean flag)
throws MessagingException
Deletes this folder.
This method can only be invoked on a closed folder.
- delete in interface Folder
- true if the folder is deleted successfully, false otherwise
exists
public boolean exists()
throws MessagingException
Indicates whether this folder exists in the Store.
This method can be invoked on a closed folder.
- exists in interface Folder
expunge
public Message[] expunge()
throws MessagingException
Expunges (permanently removing) all the messages marked DELETED.
Returns an array containing the expunged messages.
Expunge causes the renumbering of any messages with numbers higher than
the message number of the lowest-numbered expunged message.
After a message has been expunged, only the
isExpunged
and
getMessageNumber
methods are still valid on the
corresponding Message object; other methods may throw
MessageRemovedException
.
- expunge in interface Folder
getFullName
public String getFullName()
Returns the full name of this folder.
If the folder resides under the root hierarchy of its 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.
- getFullName in interface Folder
getMessage
public Message getMessage(int msgnum)
throws MessagingException
Returns the message with the given number.
The message number is the relative position of a message in its
folder, starting at 1.
Note that message numbers can change within a session if the folder is
expunged, therefore the use of message numbers as references to
messages is inadvisable.
- getMessage in interface Folder
msgnum
- the message number
getMessageCount
public int getMessageCount()
throws MessagingException
Returns the number of messages in this folder.
This method can be invoked on a closed folder; however,
note that for some stores, getting the message count can be an
expensive operation involving actually opening the folder.
In such cases, a provider can choose to return -1 here when the folder
is closed.
- getMessageCount in interface Folder
getName
public String getName()
Returns the name of this folder.
This method can be invoked on a closed folder.
- getName in interface Folder
getParent
public Folder getParent()
throws MessagingException
Returns the parent folder of this folder, or
null
if this folder is the root of a folder hierarchy.
This method can be invoked on a closed folder.
- getParent in interface Folder
getPermanentFlags
public Flags getPermanentFlags()
Returns the permanent flags supported by this folder.
- getPermanentFlags in interface Folder
getType
public int getType()
This folder contains only folders.
- getType in interface Folder
hasNewMessages
public boolean hasNewMessages()
throws MessagingException
Indicates whether this folder has new messages.
This method can be invoked on a closed folder that can contain
messages.
- hasNewMessages in interface Folder
isOpen
public boolean isOpen()
Indicates whether this folder is open.
- isOpen in interface Folder
list
public Folder[] list(String pattern)
throws MessagingException
Returns the list of folders matching the specified pattern.
- list in interface Folder
pattern
- the JavaMail pattern
list
public Folder[] list(String pattern,
ListFolderListener listener)
throws MessagingException
Returns the list of folders matching the specified pattern.
pattern
- the JavaMail patternlistener
- the listener that will be called for each folder name
as soon as it is known
list
public Folder[] list(ListFolderListener listener)
throws MessagingException
Returns the list of folders matching the specified pattern.
listener
- the listener to be called as soon as a new folder is
listed
listSubscribed
public Folder[] listSubscribed(String pattern)
throws MessagingException
Returns the list of subscribed folders matching the specified pattern.
- listSubscribed in interface Folder
pattern
- the JavaMail pattern
open
public void open(int mode)
throws MessagingException
Opens this folder.
This method can only be invoked on a closed folder that can contain
messages.
- open in interface Folder
mode
- open the Folder READ_ONLY or READ_WRITE
renameTo
public boolean renameTo(Folder folder)
throws MessagingException
Renames this folder.
This method can only be invoked on a closed folder.
- renameTo in interface Folder
folder
- a folder representing the new name for this folder
- true if the folder is renamed successfully, false otherwise