org.apache.james.imap.message.response

Class FetchResponse

java.lang.Object

org.apache.james.imap.message.response.FetchResponse

All Implemented Interfaces:

ImapMessage, ImapResponseMessage

public final class FetchResponse
extends Object
implements ImapResponseMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FetchResponse.BodyElement BODY FETCH element content.
static interface	FetchResponse.Envelope ENVELOPE content.
static interface	FetchResponse.Structure Describes the message structure.

Constructor Summary

Constructors

Constructor and Description
FetchResponse(int messageNumber, javax.mail.Flags flags, Long uid, Long modSeq, Date internalDate, Long size, FetchResponse.Envelope envelope, FetchResponse.Structure body, FetchResponse.Structure bodystructure, List<FetchResponse.BodyElement> elements)

Method Summary

Methods

Modifier and Type	Method and Description
FetchResponse.Structure	getBody() Gets the structure of this message.
FetchResponse.Structure	getBodyStructure() Gets the structure of this message.
List<FetchResponse.BodyElement>	getElements() TODO: replace
FetchResponse.Envelope	getEnvelope() Gets the envelope for the fetched message
javax.mail.Flags	getFlags() Gets the fetched flags.
Date	getInternalDate() Gets the internal date for the fetched message.
int	getMessageNumber() Gets the number of the message whose details have been fetched.
Long	getModSeq() Return the mod-sequence for the message or null if the FETCH did not include it
Long	getSize() Gets the size for the fetched message.
Long	getUid() Gets the unique id for the fetched message.

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchResponse

public FetchResponse(int messageNumber,
             javax.mail.Flags flags,
             Long uid,
             Long modSeq,
             Date internalDate,
             Long size,
             FetchResponse.Envelope envelope,
             FetchResponse.Structure body,
             FetchResponse.Structure bodystructure,
             List<FetchResponse.BodyElement> elements)

Method Detail

getBody

public FetchResponse.Structure getBody()

Gets the structure of this message.

Returns:

Structure, or null if the FETCH did not include BODY

getBodyStructure

public FetchResponse.Structure getBodyStructure()

Gets the structure of this message.

Returns:

Structure, or null if the FETCH did not include BODYSTRUCTURE

getMessageNumber

public int getMessageNumber()

Gets the number of the message whose details have been fetched.

Returns:

message number

getFlags

public javax.mail.Flags getFlags()

Gets the fetched flags.

Returns:

Flags fetched, or null if the FETCH did not include FLAGS

getUid

public Long getUid()

Gets the unique id for the fetched message.

Returns:

message uid, or null if the FETCH did not include UID

getInternalDate

public Date getInternalDate()

Gets the internal date for the fetched message.

Returns:

the internalDate, or null if the FETCH did not include INTERNALDATE

getSize

public Long getSize()

Gets the size for the fetched message.

Returns:

the size, or null if the FETCH did not include SIZE

getEnvelope

public FetchResponse.Envelope getEnvelope()

Gets the envelope for the fetched message

Returns:

the envelope, or null if the FETCH did not include ENVELOPE

getElements

public List<FetchResponse.BodyElement> getElements()

TODO: replace

Returns:

List of BodyElement's, or null if the FETCH did not include body elements

getModSeq

public Long getModSeq()

Return the mod-sequence for the message or null if the FETCH did not include it

Returns:

modSeq