You are currently viewing a snapshot of www.mozilla.org taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to www.mozilla.org, please file a bug.

All Packages  This Package  Class Hierarchy  Class Search  Index

Class grendel.storage.NewsFolderRoot

java.lang.Object
   |
   +----javax.mail.Folder
           |
           +----grendel.storage.NewsFolderRoot

This class implements a Folder representing the root-level of a news server. That is, this is the folder that holds all of the user's subscribed newsgroups. This folder has children and not messages; its children hold messages and (probably) not folders.

class  NewsFolderRoot
     extends javax.mail.Folder
{
          // Fields 1
     NewsStore store;

          // Constructors 1
     NewsFolderRoot(Store);

          // Methods 24
     public void appendMessages(Message[]) throws MessagingException;
     public void close(boolean) throws MessagingException;
     public boolean create(int);
     public boolean delete(boolean);
     long deletedMessageBytes();
     public boolean exists();
     public Message[] expunge() throws MessagingException;
     public void fetch(Message[], FetchProfile);
     public Folder getFolder(String);
     public String getFullName();
     public Message getMessage(int);
     public int getMessageCount();
     public String getName();
     public Folder getParent();
     public Flags getPermanentFlags();
     public char getSeparator();
     public int getType();
     public int getUndeletedMessageCount();
     public int getUnreadMessageCount();
     public boolean hasNewMessages();
     public boolean isOpen();
     public Folder[] list(String);
     public void open(int);
     public boolean renameTo(Folder);
}

Fields

• store

   NewsStore store

Constructors

• NewsFolderRoot

   NewsFolderRoot(Store s)

Methods

• getSeparator

   public char getSeparator()

Overrides:
getSeparator in class Folder

• getType

   public int getType()

Overrides:
getType in class Folder

• getName

   public String getName()

Overrides:
getName in class Folder

• getFullName

   public String getFullName()

Overrides:
getFullName in class Folder

• getParent

   public Folder getParent()

Overrides:
getParent in class Folder

• list

   public Folder[] list(String pattern)

Overrides:
list in class Folder

• getFolder

   public Folder getFolder(String subfolder)

Overrides:
getFolder in class Folder

• create

   public boolean create(int type)

Overrides:
create in class Folder

• exists

   public boolean exists()

Overrides:
exists in class Folder

• hasNewMessages

   public boolean hasNewMessages()

Overrides:
hasNewMessages in class Folder

• getMessageCount

   public int getMessageCount()

Returns the total number of messages in the folder, or -1 if unknown. This includes deleted and unread messages.

Overrides:
getMessageCount in class Folder

• getUndeletedMessageCount

   public int getUndeletedMessageCount()

Returns the number of non-deleted messages in the folder, or -1 if unknown. This includes unread messages.

• getUnreadMessageCount

   public int getUnreadMessageCount()

Returns the number of unread messages in the folder, or -1 if unknown. This does not include unread messages that are also deleted.

Overrides:
getUnreadMessageCount in class Folder

• deletedMessageBytes

   long deletedMessageBytes()

Returns the number of bytes consumed by deleted but not expunged messages in the folder, or -1 if unknown.

• appendMessages

   public void appendMessages(Message[] msgs)  throws MessagingException

Overrides:
appendMessages in class Folder

• fetch

   public void fetch(Message[] msgs, 
                     FetchProfile fp)

Overrides:
fetch in class Folder

• expunge

   public Message[] expunge()  throws MessagingException

Overrides:
expunge in class Folder

• delete

   public boolean delete(boolean recurse)

Overrides:
delete in class Folder

• renameTo

   public boolean renameTo(Folder f)

Overrides:
renameTo in class Folder

• open

   public void open(int mode)

Overrides:
open in class Folder

• close

   public void close(boolean doExpunge)  throws MessagingException

Overrides:
close in class Folder

• isOpen

   public boolean isOpen()

Overrides:
isOpen in class Folder

• getPermanentFlags

   public Flags getPermanentFlags()

Overrides:
getPermanentFlags in class Folder

• getMessage

   public Message getMessage(int msgnum)

Overrides:
getMessage in class Folder

All Packages  This Package  Class Hierarchy  Class Search  Index

Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.4