org.apache.james.mailbox
Interface MessageResult.FetchGroup

All Known Implementing Classes:

FetchGroupImpl

Enclosing interface:

MessageResult

public static interface MessageResult.FetchGroup

Indicates the results fetched.

Nested Class Summary

static interface

MessageResult.FetchGroup.PartContentDescriptor Describes the contents to be fetched for a mail part.

Field Summary

static int	BODY_CONTENT
static int	FULL_CONTENT
static int	HEADERS
static int	MIME_CONTENT
static int	MIME_DESCRIPTOR
static int	MIME_HEADERS
static int	MINIMAL For example: could have best performance when doing store and then forget.

Method Summary

int	content() Contents to be fetched.
java.util.Set<MessageResult.FetchGroup.PartContentDescriptor>	getPartContentDescriptors() Gets contents to be fetched for contained parts.

Field Detail

MINIMAL

static final int MINIMAL

For example: could have best performance when doing store and then forget. UIDs are always returned

See Also:

Constant Field Values

MIME_DESCRIPTOR

static final int MIME_DESCRIPTOR

See Also:

Constant Field Values

HEADERS

static final int HEADERS

See Also:

Constant Field Values

FULL_CONTENT

static final int FULL_CONTENT

See Also:

Constant Field Values

BODY_CONTENT

static final int BODY_CONTENT

See Also:

Constant Field Values

MIME_HEADERS

static final int MIME_HEADERS

See Also:

Constant Field Values

MIME_CONTENT

static final int MIME_CONTENT

See Also:

Constant Field Values

Method Detail

content

int content()

Contents to be fetched. Composed bitwise.

Returns:

bitwise descripion

See Also:

MINIMAL, #MIME_MESSAGE, #KEY, HEADERS, FULL_CONTENT, BODY_CONTENT, MIME_CONTENT

getPartContentDescriptors

java.util.Set<MessageResult.FetchGroup.PartContentDescriptor> getPartContentDescriptors()

Gets contents to be fetched for contained parts. For each part to be contained, only one descriptor should be contained.

Returns:

Set of MessageResult.FetchGroup.PartContentDescriptor, or null if there is no part content to be fetched