org.apache.james.imap.api.message

Class MessageFlags

java.lang.Object

org.apache.james.imap.api.message.MessageFlags

public class MessageFlags
extends Object

The set of flags associated with a message. TODO - why not use javax.mail.Flags instead of having our own.

Reference: RFC 2060 - para 2.3

Field Summary

Fields

Modifier and Type	Field and Description
static javax.mail.Flags	ALL_FLAGS
static String	ANSWERED_ALL_CAPS
static String	ANSWERED_OUTPUT_CAPITALISED
static String	DELETED_ALL_CAPS
static String	DELETED_OUTPUT_CAPITALISED
static String	DRAFT_ALL_CAPS
static String	DRAFT_OUTPUT_CAPITALISED
static String	FLAGGED_ALL_CAPS
static String	FLAGGED_OUTPUT_CAPITALISED
static String	RECENT_ALL_CAPS
static String	RECENT_OUTPUT_CAPITALISED
static String	SEEN_ALL_CAPS
static String	SEEN_OUTPUT_CAPITALISED
static String	USER_OUTPUT_CAPITALISED

Constructor Summary

Constructors

Constructor and Description
MessageFlags()

Method Summary

Methods

Modifier and Type	Method and Description
static String	format(javax.mail.Flags flags) Returns IMAP formatted String of MessageFlags for named user
static Collection<String>	names(javax.mail.Flags flags) Returns IMAP formatted String naming flags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEEN_OUTPUT_CAPITALISED

public static final String SEEN_OUTPUT_CAPITALISED

See Also:

Constant Field Values

RECENT_OUTPUT_CAPITALISED

public static final String RECENT_OUTPUT_CAPITALISED

See Also:

Constant Field Values

FLAGGED_OUTPUT_CAPITALISED

public static final String FLAGGED_OUTPUT_CAPITALISED

See Also:

Constant Field Values

DRAFT_OUTPUT_CAPITALISED

public static final String DRAFT_OUTPUT_CAPITALISED

See Also:

Constant Field Values

DELETED_OUTPUT_CAPITALISED

public static final String DELETED_OUTPUT_CAPITALISED

See Also:

Constant Field Values

ANSWERED_OUTPUT_CAPITALISED

public static final String ANSWERED_OUTPUT_CAPITALISED

See Also:

Constant Field Values

USER_OUTPUT_CAPITALISED

public static final String USER_OUTPUT_CAPITALISED

See Also:

Constant Field Values

ALL_FLAGS

public static final javax.mail.Flags ALL_FLAGS

ANSWERED_ALL_CAPS

public static final String ANSWERED_ALL_CAPS

See Also:

Constant Field Values

DELETED_ALL_CAPS

public static final String DELETED_ALL_CAPS

See Also:

Constant Field Values

DRAFT_ALL_CAPS

public static final String DRAFT_ALL_CAPS

See Also:

Constant Field Values

FLAGGED_ALL_CAPS

public static final String FLAGGED_ALL_CAPS

See Also:

Constant Field Values

SEEN_ALL_CAPS

public static final String SEEN_ALL_CAPS

See Also:

Constant Field Values

RECENT_ALL_CAPS

public static final String RECENT_ALL_CAPS

See Also:

Constant Field Values

Constructor Detail

MessageFlags

public MessageFlags()

Method Detail

names

public static Collection<String> names(javax.mail.Flags flags)

Returns IMAP formatted String naming flags.

Returns:

Collection of String's naming the flags.

format

public static String format(javax.mail.Flags flags)

Returns IMAP formatted String of MessageFlags for named user