All Packages  This Package  Class Hierarchy  Class Search  Index

Interface grendel.storage.MailDrop

Interface to a maildrop: a place that we get new mail from.

public interface  MailDrop
{
          // Fields 3
     public static final int NEW;
     public static final int NONE;
     public static final int UNKNOWN;

          // Methods 4
     public abstract void doBiff() throws IOException;
     public abstract void fetchNewMail() throws IOException;
     public abstract int getBiffState();
     public abstract int getNumMessagesWaiting();
}

• NEW

   public static final int NEW

Returned by getBiffState() if there are new messages waiting.

• NONE

   public static final int NONE

Returned by getBiffState() if there are no new messages waiting.

• UNKNOWN

   public static final int UNKNOWN

Returned by getBiffState() if we can't tell if there are new messages waiting.

• fetchNewMail

   public abstract void fetchNewMail()  throws IOException

Actually go to maildrop, grab any messages, and stuff them into folders.

• doBiff

   public abstract void doBiff()  throws IOException

Go to the maildrop and update the info on how many messages out there are waiting.

• getBiffState

   public abstract int getBiffState() 

Find out whether we actually know anything about new messages waiting on the maildrop.

• getNumMessagesWaiting

   public abstract int getNumMessagesWaiting() 

Return how many new messages are out there waiting. If getBiffState() returns NONE, returns zero. If getBiffState() returns UNKNOWN, or if we just can't tell with this maildrop, returns -1.

All Packages  This Package  Class Hierarchy  Class Search  Index