rice.email.proxy.mailbox
Interface FlagList

All Known Implementing Classes:

FileFlagList, PostFlagList

public interface FlagList

Field Summary

static java.lang.String	ANSWERED_FLAG
static java.lang.String	DELETED_FLAG static names of all the server-provided flags
static java.lang.String	DRAFT_FLAG
static java.lang.String	FLAGGED_FLAG
static java.lang.String	RECENT_FLAG
static java.lang.String	SEEN_FLAG

Method Summary

void	commit() Causes any changes in this FlagList's state to be written to the associated Mailbox.
java.util.List	getFlags()
boolean	isAnswered()
boolean	isDeleted()
boolean	isDraft()
boolean	isFlagged()
boolean	isRecent() Methods which support the session flags, as well as the \Recent flag
boolean	isSeen()
boolean	isSet(java.lang.String flag) Methods which allow the querying of flags
void	setAnswered(boolean value)
void	setDeleted(boolean value)
void	setDraft(boolean value)
void	setFlag(java.lang.String flag, boolean value) Methods which allow the modification of flags
void	setFlagged(boolean value)
void	setRecent(boolean value)
void	setSeen(boolean value)
java.lang.String	toFlagString() Utility method for conversion to a string

Field Detail

DELETED_FLAG

static final java.lang.String DELETED_FLAG

static names of all the server-provided flags

See Also:

Constant Field Values

ANSWERED_FLAG

static final java.lang.String ANSWERED_FLAG

See Also:

Constant Field Values

SEEN_FLAG

static final java.lang.String SEEN_FLAG

See Also:

Constant Field Values

DRAFT_FLAG

static final java.lang.String DRAFT_FLAG

See Also:

Constant Field Values

FLAGGED_FLAG

static final java.lang.String FLAGGED_FLAG

See Also:

Constant Field Values

RECENT_FLAG

static final java.lang.String RECENT_FLAG

See Also:

Constant Field Values

Method Detail

setFlag

void setFlag(java.lang.String flag,
             boolean value)

Methods which allow the modification of flags

setDeleted

void setDeleted(boolean value)

setSeen

void setSeen(boolean value)

setDraft

void setDraft(boolean value)

setFlagged

void setFlagged(boolean value)

setAnswered

void setAnswered(boolean value)

isSet

boolean isSet(java.lang.String flag)

Methods which allow the querying of flags

isDeleted

boolean isDeleted()

isSeen

boolean isSeen()

isDraft

boolean isDraft()

isAnswered

boolean isAnswered()

isFlagged

boolean isFlagged()

toFlagString

java.lang.String toFlagString()

Utility method for conversion to a string

getFlags

java.util.List getFlags()

isRecent

boolean isRecent()

Methods which support the session flags, as well as the \Recent flag

setRecent

void setRecent(boolean value)

commit

void commit()
            throws MailboxException

Causes any changes in this FlagList's state to be written to the associated Mailbox. This allows colapsing several changes into one disk write, one SQL command, etc.

Throws:

MailboxException