org.apache.james.mailbox.store.mail

Enum MessageMapper.FetchType

java.lang.Object

java.lang.Enum<MessageMapper.FetchType>

org.apache.james.mailbox.store.mail.MessageMapper.FetchType

All Implemented Interfaces:

Serializable, Comparable<MessageMapper.FetchType>

Enclosing interface:

MessageMapper<Id>

public static enum MessageMapper.FetchType
extends Enum<MessageMapper.FetchType>

Specify what data needs to get filled in a Message before returning it

Enum Constant Summary

Enum Constants

Enum Constant and Description
Body Fetch the Metadata and the Body for the Message.
Full Fetch the complete Message
Headers Fetch the Metadata, Property's and the Headers's for the Message.
Metadata Fetch only the meta data of the Message which includes:

Method Summary

Methods

Modifier and Type	Method and Description
static MessageMapper.FetchType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageMapper.FetchType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Metadata

public static final MessageMapper.FetchType Metadata

Fetch only the meta data of the Message which includes:

Message.getUid() Message.getModSeq() Message.getBodyOctets() Message.getFullContentOctets() Message.getInternalDate() Message.getMailboxId() Message.getMediaType() Message.getModSeq() Message.getSubType() Message.getTextualLineCount()

Headers

public static final MessageMapper.FetchType Headers

Fetch the Metadata, Property's and the Headers's for the Message. This includes:

Message.getProperties() Message.getHeaderContent()

Body

public static final MessageMapper.FetchType Body

Fetch the Metadata and the Body for the Message. This includes:

Message.getBodyContent()

Full

public static final MessageMapper.FetchType Full

Fetch the complete Message

Method Detail

values

public static MessageMapper.FetchType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MessageMapper.FetchType c : MessageMapper.FetchType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessageMapper.FetchType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null