org.apache.james.mailbox.model

Interface MessageResult

All Superinterfaces:

Comparable<MessageResult>, MessageMetaData

All Known Implementing Classes:

MessageResultImpl

public interface MessageResult
extends Comparable<MessageResult>, MessageMetaData

Used to get specific informations about a Message without dealing with a MimeMessage instance. Demanded information can be requested by binary combining the constants.

I came to the Idea of the MessageResult because there are many possible combinations of different requests (uid, msn, MimeMessage, Flags).

e.g. I want to have all uids, msns and flags of all messages. (a common IMAP operation) Javamail would do it that way:

1. get all Message objects (Message[])
2. call Message.getMessageNumber()
3. call Message.getFlags()
4. call Folder.getUid(Message)

This means creating a lazy-loading MimeMessage instance.
So why don't call getMessages(MessageResult.UID | MessageResult.MSN | MessageResult.FLAGS)? This would leave a lot of room for the implementation to optimize

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageResult.FetchGroup Indicates the results fetched.
static interface	MessageResult.Header A header.
static interface	MessageResult.MimePath Describes a path within a multipart MIME message.

Method Summary

Methods

Modifier and Type	Method and Description
Content	getBody() Gets the body of the message excluding headers.
Content	getBody(MessageResult.MimePath path) Gets the body of the given mime part.
Content	getFullContent() Gets the full message including headers and body.
Content	getFullContent(MessageResult.MimePath path) Gets the full content of the given mime part.
Headers	getHeaders()
Content	getMimeBody(MessageResult.MimePath path) Gets the body of the given mime part.
MimeDescriptor	getMimeDescriptor()
Iterator<MessageResult.Header>	iterateHeaders(MessageResult.MimePath path) Iterates the message headers for the given part in a multipart message.
Iterator<MessageResult.Header>	iterateMimeHeaders(MessageResult.MimePath path) Iterates the MIME headers for the given part in a multipart message.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apache.james.mailbox.model.MessageMetaData

getFlags, getInternalDate, getModSeq, getSize, getUid

Method Detail

getMimeDescriptor

MimeDescriptor getMimeDescriptor()
                                 throws MailboxException

Throws:

MailboxException

iterateHeaders

Iterator<MessageResult.Header> iterateHeaders(MessageResult.MimePath path)
                                              throws MailboxException

Iterates the message headers for the given part in a multipart message.

Parameters:

path - describing the part's position within a multipart message

Returns:

Header Iterator, or null when MessageResult.FetchGroup.content() does not include the index and when the mime part cannot be found

Throws:

MailboxException

iterateMimeHeaders

Iterator<MessageResult.Header> iterateMimeHeaders(MessageResult.MimePath path)
                                                  throws MailboxException

Iterates the MIME headers for the given part in a multipart message.

Parameters:

path - describing the part's position within a multipart message

Returns:

Header Iterator, or null when MessageResult.FetchGroup.content() does not include the index and when the mime part cannot be found

Throws:

MailboxException

getFullContent

Content getFullContent()
                       throws MailboxException,
                              IOException

Gets the full message including headers and body. The message data should have normalised line endings (CRLF).

Returns:

Content, or or null if MessageResult.FetchGroup.FULL_CONTENT has not been included in the results

Throws:

IOException

MailboxException

getFullContent

Content getFullContent(MessageResult.MimePath path)
                       throws MailboxException

Gets the full content of the given mime part.

Parameters:

path - describes the part

Returns:

Content, or null when MessageResult.FetchGroup.content() did not been include the given index and when the mime part cannot be found

Throws:

MailboxException

getBody

Content getBody()
                throws MailboxException,
                       IOException

Gets the body of the message excluding headers. The message data should have normalised line endings (CRLF).

Returns:

Content, or or null if MessageResult.FetchGroup.FULL_CONTENT has not been included in the results

Throws:

IOException

MailboxException

getBody

Content getBody(MessageResult.MimePath path)
                throws MailboxException

Gets the body of the given mime part.

Parameters:

path - describes the part

Returns:

Content, or null when MessageResult.FetchGroup.content() did not been include the given index and when the mime part cannot be found

Throws:

MailboxException

getMimeBody

Content getMimeBody(MessageResult.MimePath path)
                    throws MailboxException

Gets the body of the given mime part.

Parameters:

path - describes the part

Returns:

Content, or null when MessageResult.FetchGroup.content() did not been include the given index and when the mime part cannot be found

Throws:

MailboxException

getHeaders

Headers getHeaders()
                   throws MailboxException

Throws:

MailboxException