com.icegreen.greenmail.store
Interface MailFolder

All Known Implementing Classes:
ImapSessionFolder

public interface MailFolder

Represents a mailbox within an Store. May provide storage for MovingMessage objects, or be a non-selectable placeholder in the Mailbox hierarchy. TODO this is a "grown" interface, which needs some more design and thought re: how it will fit in with the other mail storage in James.

Version:
$Revision: 109034 $
Author:
Darrell DeBoer

Method Summary
 void addListener(FolderListener listener)
           
 long appendMessage(MimeMessage message, Flags flags, Date internalDate)
           
 void copyMessage(long uid, MailFolder toFolder)
           
 void deleteAllMessages()
           
 void expunge()
           
 int getFirstUnseen()
           
 String getFullName()
           
 SimpleStoredMessage getMessage(long uid)
           
 int getMessageCount()
           
 List getMessages()
           
 List getMessages(MsgRangeFilter msgRangeFilter)
           
 long[] getMessageUids()
           
 int getMsn(long uid)
           
 String getName()
           
 List getNonDeletedMessages()
           
 Flags getPermanentFlags()
           
 int getRecentCount(boolean reset)
           
 long getUidNext()
           
 long getUidValidity()
           
 int getUnseenCount()
           
 boolean isSelectable()
           
 void removeListener(FolderListener listener)
           
 void replaceFlags(Flags flags, long uid, FolderListener silentListener, boolean addUid)
           
 long[] search(SearchTerm searchTerm)
           
 void setFlags(Flags flags, boolean value, long uid, FolderListener silentListener, boolean addUid)
           
 void signalDeletion()
           
 void store(MimeMessage mail)
           
 void store(MovingMessage mail)
           
 

Method Detail

getName

String getName()

getFullName

String getFullName()

getPermanentFlags

Flags getPermanentFlags()

getMessageCount

int getMessageCount()

getRecentCount

int getRecentCount(boolean reset)

getUidValidity

long getUidValidity()

getFirstUnseen

int getFirstUnseen()

getUnseenCount

int getUnseenCount()

isSelectable

boolean isSelectable()

getUidNext

long getUidNext()

appendMessage

long appendMessage(MimeMessage message,
                   Flags flags,
                   Date internalDate)

deleteAllMessages

void deleteAllMessages()

expunge

void expunge()
             throws FolderException
Throws:
FolderException

addListener

void addListener(FolderListener listener)

removeListener

void removeListener(FolderListener listener)

store

void store(MovingMessage mail)
           throws Exception
Throws:
Exception

store

void store(MimeMessage mail)
           throws Exception
Throws:
Exception

getMessage

SimpleStoredMessage getMessage(long uid)

getMessageUids

long[] getMessageUids()

search

long[] search(SearchTerm searchTerm)

copyMessage

void copyMessage(long uid,
                 MailFolder toFolder)
                 throws FolderException
Throws:
FolderException

setFlags

void setFlags(Flags flags,
              boolean value,
              long uid,
              FolderListener silentListener,
              boolean addUid)
              throws FolderException
Throws:
FolderException

replaceFlags

void replaceFlags(Flags flags,
                  long uid,
                  FolderListener silentListener,
                  boolean addUid)
                  throws FolderException
Throws:
FolderException

getMsn

int getMsn(long uid)
           throws FolderException
Throws:
FolderException

signalDeletion

void signalDeletion()

getMessages

List getMessages(MsgRangeFilter msgRangeFilter)

getMessages

List getMessages()

getNonDeletedMessages

List getNonDeletedMessages()