org.apache.james.mailbox.store

Class MessageResultImpl

java.lang.Object

org.apache.james.mailbox.store.MessageResultImpl

All Implemented Interfaces:

Comparable<MessageResult>, MessageMetaData, MessageResult

public class MessageResultImpl
extends Object
implements MessageResult

Bean based implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.model.MessageResult

MessageResult.FetchGroup, MessageResult.Header, MessageResult.MimePath

Constructor Summary

Constructors

Constructor and Description
MessageResultImpl(Message<?> message)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MessageResult that)
boolean	equals(Object obj)
Content	getBody() Gets the body of the message excluding headers.
Content	getBody(MessageResult.MimePath path) Gets the body of the given mime part.
javax.mail.Flags	getFlags() Return the Flags
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()
Date	getInternalDate() IMAP defines this as the time when the message has arrived to the server (by smtp).
Content	getMimeBody(MessageResult.MimePath path) Gets the body of the given mime part.
MimeDescriptor	getMimeDescriptor()
long	getModSeq() Return the modify-sequence number of the message.
long	getSize() Return the size in bytes
long	getUid() Return the uid of the message which the MessageResult belongs to
int	hashCode()
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.
void	setBodyContent(MessageResult.MimePath path, Content content)
void	setFullContent(MessageResult.MimePath path, Content content)
void	setHeaders(MessageResult.MimePath path, Iterator<MessageResult.Header> headers)
void	setMimeBodyContent(MessageResult.MimePath path, Content content)
void	setMimeHeaders(MessageResult.MimePath path, Iterator<MessageResult.Header> headers)
String	toString() Renders suitably for logging.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageResultImpl

public MessageResultImpl(Message<?> message)
                  throws IOException

Throws:

IOException

Method Detail

getUid

public long getUid()

Description copied from interface: MessageMetaData

Return the uid of the message which the MessageResult belongs to

Specified by:

getUid in interface MessageMetaData

Returns:

uid

See Also:

MessageMetaData.getUid()

getInternalDate

public Date getInternalDate()

Description copied from interface: MessageMetaData

IMAP defines this as the time when the message has arrived to the server (by smtp). Clients are also allowed to set the internalDate on append.

Specified by:

getInternalDate in interface MessageMetaData

See Also:

MessageMetaData.getInternalDate()

getFlags

public javax.mail.Flags getFlags()

Description copied from interface: MessageMetaData

Return the Flags

Specified by:

getFlags in interface MessageMetaData

Returns:

flags

See Also:

MessageMetaData.getFlags()

getSize

public long getSize()

Description copied from interface: MessageMetaData

Return the size in bytes

Specified by:

getSize in interface MessageMetaData

Returns:

size

See Also:

MessageMetaData.getSize()

compareTo

public int compareTo(MessageResult that)

Specified by:

compareTo in interface Comparable<MessageResult>

See Also:

Comparable.compareTo(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getFullContent

public final Content getFullContent()
                             throws IOException

Description copied from interface: MessageResult

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

Specified by:

getFullContent in interface MessageResult

Returns:

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

Throws:

IOException

See Also:

MessageResult.getFullContent()

getBody

public final Content getBody()
                      throws IOException

Description copied from interface: MessageResult

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

Specified by:

getBody in interface MessageResult

Returns:

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

Throws:

IOException

See Also:

MessageResult.getBody()

toString

public String toString()

Renders suitably for logging.

Overrides:

toString in class Object

Returns:

a String representation of this object.

getBody

public Content getBody(MessageResult.MimePath path)
                throws MailboxException

Description copied from interface: MessageResult

Gets the body of the given mime part.

Specified by:

getBody in interface MessageResult

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

See Also:

MessageResult.getBody(org.apache.james.mailbox.model.MessageResult.MimePath)

getMimeBody

public Content getMimeBody(MessageResult.MimePath path)
                    throws MailboxException

Description copied from interface: MessageResult

Gets the body of the given mime part.

Specified by:

getMimeBody in interface MessageResult

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

See Also:

MessageResult.getMimeBody(org.apache.james.mailbox.model.MessageResult.MimePath)

getFullContent

public Content getFullContent(MessageResult.MimePath path)
                       throws MailboxException

Description copied from interface: MessageResult

Gets the full content of the given mime part.

Specified by:

getFullContent in interface MessageResult

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

See Also:

MessageResult.getFullContent(org.apache.james.mailbox.model.MessageResult.MimePath)

iterateHeaders

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

Description copied from interface: MessageResult

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

Specified by:

iterateHeaders in interface MessageResult

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

See Also:

MessageResult.iterateHeaders(org.apache.james.mailbox.model.MessageResult.MimePath)

iterateMimeHeaders

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

Description copied from interface: MessageResult

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

Specified by:

iterateMimeHeaders in interface MessageResult

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

See Also:

MessageResult.iterateMimeHeaders(org.apache.james.mailbox.model.MessageResult.MimePath)

setBodyContent

public void setBodyContent(MessageResult.MimePath path,
                  Content content)

setMimeBodyContent

public void setMimeBodyContent(MessageResult.MimePath path,
                      Content content)

setFullContent

public void setFullContent(MessageResult.MimePath path,
                  Content content)

setHeaders

public void setHeaders(MessageResult.MimePath path,
              Iterator<MessageResult.Header> headers)

setMimeHeaders

public void setMimeHeaders(MessageResult.MimePath path,
                  Iterator<MessageResult.Header> headers)

getMimeDescriptor

public MimeDescriptor getMimeDescriptor()
                                 throws MailboxException

Specified by:

getMimeDescriptor in interface MessageResult

Throws:

MailboxException

See Also:

MessageResult.getMimeDescriptor()

getModSeq

public long getModSeq()

Description copied from interface: MessageMetaData

Return the modify-sequence number of the message. This is kind of optional and the mailbox implementation may not support this. If so it will return -1

Specified by:

getModSeq in interface MessageMetaData

Returns:

modSeq

See Also:

MessageMetaData.getModSeq()

getHeaders

public Headers getHeaders()
                   throws MailboxException

Specified by:

getHeaders in interface MessageResult

Throws:

MailboxException