Package 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

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

Method Detail

getName

java.lang.String getName()

getFullName

java.lang.String getFullName()

getPermanentFlags

javax.mail.Flags getPermanentFlags()

getMessageCount

int getMessageCount()

getRecentCount

int getRecentCount(boolean reset)

getUidValidity

long getUidValidity()

getFirstUnseen

int getFirstUnseen()

getUnseenCount

int getUnseenCount()

isSelectable

boolean isSelectable()

isMarked

boolean isMarked()

getUidNext

long getUidNext()

appendMessage

long appendMessage(javax.mail.internet.MimeMessage message,
                   javax.mail.Flags flags,
                   java.util.Date internalDate)
            throws FolderException

Throws:

FolderException

deleteAllMessages

void deleteAllMessages()
                throws FolderException

Throws:

FolderException

expunge

void expunge()
      throws FolderException

Throws:

FolderException

expunge

void expunge(long uid)
      throws FolderException

Throws:

FolderException

addListener

void addListener(FolderListener listener)

removeListener

void removeListener(FolderListener listener)

store

void store(MovingMessage mail)
    throws java.lang.Exception

Throws:

java.lang.Exception

store

void store(javax.mail.internet.MimeMessage mail)
    throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

SimpleStoredMessage getMessage(long uid)

getMessageUids

long[] getMessageUids()

search

long[] search(javax.mail.search.SearchTerm searchTerm)

copyMessage

long copyMessage(long uid,
                 MailFolder toFolder)
          throws FolderException

Throws:

FolderException

setFlags

void setFlags(javax.mail.Flags flags,
              boolean value,
              long uid,
              FolderListener silentListener,
              boolean addUid)
       throws FolderException

Throws:

FolderException

replaceFlags

void replaceFlags(javax.mail.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

java.util.List getMessages(MsgRangeFilter msgRangeFilter)

getMessages

java.util.List getMessages()

getNonDeletedMessages

java.util.List getNonDeletedMessages()