com.hs.mail.imap.server.codec
Interface ImapMessage

All Known Implementing Classes:

DefaultImapMessage

public interface ImapMessage

An IMAP message.

Since:

Jan 22, 2010

Author:

Won Chul Doh

Method Summary

String	getCommand()
org.jboss.netty.buffer.ChannelBuffer	getLiteral() Returns the content of this message.
long	getLiteralLength() Returns the length of the content.
LinkedList<Token>	getTokens()
boolean	isNeedContinuationRequest() Returns true if and only if we need to send command continuation request before reading literal data.
void	setLiteral(org.jboss.netty.buffer.ChannelBuffer literal) Sets the content of this message.
void	setLiteralLength(long literalLength)

Method Detail

getCommand

String getCommand()

getTokens

LinkedList<Token> getTokens()

getLiteral

org.jboss.netty.buffer.ChannelBuffer getLiteral()

Returns the content of this message. If there is no content, an ChannelBuffers.EMPTY_BUFFER is returned.

setLiteral

void setLiteral(org.jboss.netty.buffer.ChannelBuffer literal)

Sets the content of this message. If null is specified, the content of this message will be set to ChannelBuffers.EMPTY_BUFFER.

getLiteralLength

long getLiteralLength()

Returns the length of the content. Please note that this value is not retrieved from #getContent() but from the "Content-Length" header, and thus they are independent from each other.

Returns:

the content length or 0 if this message does not have the "Content-Length" header

setLiteralLength

void setLiteralLength(long literalLength)

isNeedContinuationRequest

boolean isNeedContinuationRequest()

Returns true if and only if we need to send command continuation request before reading literal data.