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(jakarta.mail.internet.MimeMessage message, jakarta.mail.Flags flags, Date internalDate)	Appends a message.
long	copyMessage(long uid, MailFolder toFolder)
void	deleteAllMessages()
void	expunge()
void	expunge(IdRange[] idRanges)	Expunges flagged for deletion messages in given range.
int	getFirstUnseen()
String	getFullName()
StoredMessage	getMessage(long uid)
int	getMessageCount()
List<StoredMessage>	getMessages()
List<StoredMessage>	getMessages(MsgRangeFilter msgRangeFilter)
long[]	getMessageUids()
int	getMsn(long uid)
String	getName()
List<StoredMessage>	getNonDeletedMessages()
jakarta.mail.Flags	getPermanentFlags()
int	getRecentCount(boolean reset)
long	getUIDNext()
long	getUidValidity()
int	getUnseenCount()
boolean	isSelectable()
long	moveMessage(long uid, MailFolder toFolder)
void	removeListener(FolderListener listener)
void	replaceFlags(jakarta.mail.Flags flags, long uid, FolderListener silentListener, boolean addUid)
long[]	search(jakarta.mail.search.SearchTerm searchTerm)
void	setFlags(jakarta.mail.Flags flags, boolean value, long uid, FolderListener silentListener, boolean addUid)
void	signalDeletion()
void	store(MovingMessage mail)
void	store(jakarta.mail.internet.MimeMessage mail)

Method Detail

getName

String getName()

getFullName

String getFullName()

getPermanentFlags

jakarta.mail.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(jakarta.mail.internet.MimeMessage message,
                   jakarta.mail.Flags flags,
                   Date internalDate)

Appends a message.

Parameters:

message - the message.

flags - the flags.

internalDate - the received date

Returns:

the uid.

deleteAllMessages

void deleteAllMessages()

expunge

void expunge()
      throws FolderException

Throws:

FolderException

expunge

void expunge(IdRange[] idRanges)

Expunges flagged for deletion messages in given range.

Parameters:

idRanges - the ranges. Can be null.

See Also:

ExpungeCommand

addListener

void addListener(FolderListener listener)

removeListener

void removeListener(FolderListener listener)

store

void store(MovingMessage mail)
    throws Exception

Throws:

Exception

store

void store(jakarta.mail.internet.MimeMessage mail)
    throws Exception

Throws:

Exception

getMessage

StoredMessage getMessage(long uid)

getMessageUids

long[] getMessageUids()

search

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

copyMessage

long copyMessage(long uid,
                 MailFolder toFolder)
          throws FolderException

Throws:

FolderException

moveMessage

long moveMessage(long uid,
                 MailFolder toFolder)
          throws FolderException

Throws:

FolderException

setFlags

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

Throws:

FolderException

replaceFlags

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

List<StoredMessage> getMessages(MsgRangeFilter msgRangeFilter)

getMessages

List<StoredMessage> getMessages()

getNonDeletedMessages

List<StoredMessage> getNonDeletedMessages()