Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

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.

Field Summary

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, READ_ONLY, READ_WRITE, mode, store

Method Summary

void
appendMessages(Message[] messages)
void
close(boolean expunge)
boolean
create(int type)
boolean
delete(boolean flag)
boolean
exists()
Message[]
expunge()
Folder
getFolder(String name)
Returns a new Folder object associated with the specified name.
String
getFullName()
Message
getMessage(int msgnum)
int
getMessageCount()
String
getName()
Folder
getParent()
Flags
getPermanentFlags()
char
getSeparator()
As we're dealing with a flat namespace, the value of this is irrelevant.
int
getType()
This folder contains only folders.
boolean
hasNewMessages()
boolean
isOpen()
Folder[]
list(String pattern)
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[]
list(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.
void
open(int mode)
boolean
renameTo(Folder folder)
void
setSubscribed(boolean flag)
This folder is always "subscribed".

Methods inherited from class javax.mail.Folder

addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, appendMessages, close, copyMessages, create, delete, exists, expunge, fetch, getDeletedMessageCount, getFolder, getFullName, getMessage, getMessageCount, getMessages, getMessages, getMessages, getMode, getName, getNewMessageCount, getParent, getPermanentFlags, getSeparator, getStore, getType, getURLName, getUnreadMessageCount, hasNewMessages, isOpen, isSubscribed, list, list, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, open, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, renameTo, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Method Details

appendMessages

public void appendMessages(Message[] messages)
            throws MessagingException
Overrides:
appendMessages in interface Folder

close

public void close(boolean expunge)
            throws MessagingException
Overrides:
close in interface Folder

create

public boolean create(int type)
            throws MessagingException
Overrides:
create in interface Folder

delete

public boolean delete(boolean flag)
            throws MessagingException
Overrides:
delete in interface Folder

exists

public boolean exists()
            throws MessagingException
Overrides:
exists in interface Folder

expunge

public Message[] expunge()
            throws MessagingException
Overrides:
expunge in interface Folder

getFolder

public Folder getFolder(String name)
            throws MessagingException
Returns a new Folder object associated with the specified name.
Overrides:
getFolder in interface Folder

getFullName

public String getFullName()
Overrides:
getFullName in interface Folder

getMessage

public Message getMessage(int msgnum)
            throws MessagingException
Overrides:
getMessage in interface Folder

getMessageCount

public int getMessageCount()
            throws MessagingException
Overrides:
getMessageCount in interface Folder

getName

public String getName()
Overrides:
getName in interface Folder

getParent

public Folder getParent()
            throws MessagingException
Overrides:
getParent in interface Folder

getPermanentFlags

public Flags getPermanentFlags()
Overrides:
getPermanentFlags in interface Folder

getSeparator

public char getSeparator()
            throws MessagingException
As we're dealing with a flat namespace, the value of this is irrelevant.
Overrides:
getSeparator in interface Folder

getType

public int getType()
This folder contains only folders.
Overrides:
getType in interface Folder

hasNewMessages

public boolean hasNewMessages()
            throws MessagingException
Overrides:
hasNewMessages in interface Folder

isOpen

public boolean isOpen()
Overrides:
isOpen in interface Folder

list

public Folder[] list(String pattern)
            throws MessagingException
Returns the list of folders matching the specified pattern.
Overrides:
list in interface Folder
Parameters:
pattern - the JavaMail pattern

list

public Folder[] list(String pattern,
                     ListFolderListener listener)
            throws MessagingException
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

list

public Folder[] list(ListFolderListener listener)
            throws MessagingException
Returns the list of folders matching the specified pattern.
Parameters:
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.
Overrides:
listSubscribed in interface Folder
Parameters:
pattern - the JavaMail pattern

open

public void open(int mode)
            throws MessagingException
Overrides:
open in interface Folder

renameTo

public boolean renameTo(Folder folder)
            throws MessagingException
Overrides:
renameTo in interface Folder

setSubscribed

public void setSubscribed(boolean flag)
            throws MessagingException
This folder is always "subscribed".
Overrides:
setSubscribed in interface Folder

Overview Package Tree Index Deprecated About