gnu.mail.providers.nntp

Class NNTPRootFolder

public final class NNTPRootFolder extends Folder

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.

Version: 2.0

Author: Chris Burdess Cedric Hyppolite

Method Summary
voidappendMessages(Message[] messages)
voidclose(boolean expunge)
booleancreate(int type)
booleandelete(boolean flag)
booleanexists()
Message[]expunge()
FoldergetFolder(String name)
Returns a new Folder object associated with the specified name.
StringgetFullName()
MessagegetMessage(int msgnum)
intgetMessageCount()
StringgetName()
FoldergetParent()
FlagsgetPermanentFlags()
chargetSeparator()
As we're dealing with a flat namespace, the value of this is irrelevant.
intgetType()
This folder contains only folders.
booleanhasNewMessages()
booleanisOpen()
Folder[]list(String pattern)
Returns the list of folders matching the specified pattern.
Folder[]list(ListFolderListener listener)
Returns the list of folders matching the specified pattern.
Folder[]list(String pattern, ListFolderListener listener)
Returns the list of folders matching the specified pattern.
Folder[]listSubscribed(String pattern)
Returns the list of subscribed folders matching the specified pattern.
voidopen(int mode)
booleanrenameTo(Folder folder)
voidsetSubscribed(boolean flag)
This folder is always "subscribed".

Method Detail

appendMessages

public void appendMessages(Message[] messages)

close

public void close(boolean expunge)

create

public boolean create(int type)

delete

public boolean delete(boolean flag)

exists

public boolean exists()

expunge

public Message[] expunge()

getFolder

public Folder getFolder(String name)
Returns a new Folder object associated with the specified name.

getFullName

public String getFullName()

getMessage

public Message getMessage(int msgnum)

getMessageCount

public int getMessageCount()

getName

public String getName()

getParent

public Folder getParent()

getPermanentFlags

public Flags getPermanentFlags()

getSeparator

public char getSeparator()
As we're dealing with a flat namespace, the value of this is irrelevant.

getType

public int getType()
This folder contains only folders.

hasNewMessages

public boolean hasNewMessages()

isOpen

public boolean isOpen()

list

public Folder[] list(String pattern)
Returns the list of folders matching the specified pattern.

Parameters: pattern the JavaMail pattern

list

public Folder[] list(ListFolderListener listener)
Returns the list of folders matching the specified pattern.

Parameters: listener the listener to be called as soon as a new folder is listed

list

public Folder[] list(String pattern, ListFolderListener listener)
Returns the list of folders matching the specified pattern.

Parameters: pattern the JavaMail pattern listener the listener that will be called for each folder name as soon as it is known

listSubscribed

public Folder[] listSubscribed(String pattern)
Returns the list of subscribed folders matching the specified pattern.

Parameters: pattern the JavaMail pattern

open

public void open(int mode)

renameTo

public boolean renameTo(Folder folder)

setSubscribed

public void setSubscribed(boolean flag)
This folder is always "subscribed".
© Copyright 2003, 2004 The Free Software Foundation, All rights reserved