org.apache.james.protocols.imap

Interface IMAPSession

All Superinterfaces:

ProtocolSession

public interface IMAPSession
extends ProtocolSession

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.protocols.api.ProtocolSession

ProtocolSession.State

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticated() Moves the session into ImapSessionState.AUTHENTICATED state.
void	deselect() Moves the session out of ImapSessionState.SELECTED state and back into ImapSessionState.AUTHENTICATED state.
int	getPushedLineHandlerCount() Return the size of the pushed LineHandler
SelectedMailbox	getSelected() Provides the selected mailbox for this session, or null if this session is not in ImapSessionState.SELECTED state.
ImapSessionState	getSessionState() Gets the current client state.
boolean	isCompressionActive() Return true if compression is active
boolean	isCompressionSupported() Return true if compression is supported.
boolean	isPlainAuthDisallowed() Return true if the login / authentication via plain username / password is disallowed
void	logout() Logs out the session.
void	popLineHandler() Pop the last command handler
void	selected(SelectedMailbox mailbox) Moves this session into ImapSessionState.SELECTED state and sets the supplied mailbox to be the currently selected mailbox.
boolean	startCompression() Start the compression
boolean	supportMultipleNamespaces() Return true if multiple namespaces are supported

Methods inherited from interface org.apache.james.protocols.api.ProtocolSession

getAttachment, getCharset, getConfiguration, getConnectionState, getLineDelimiter, getLocalAddress, getLogger, getRemoteAddress, getSessionID, getState, getUser, isStartTLSSupported, isTLSStarted, newFatalErrorResponse, newLineTooLongResponse, pushLineHandler, resetState, setAttachment, setUser

Method Detail

popLineHandler

void popLineHandler()

Pop the last command handler

Specified by:

popLineHandler in interface ProtocolSession

getPushedLineHandlerCount

int getPushedLineHandlerCount()

Return the size of the pushed LineHandler

Specified by:

getPushedLineHandlerCount in interface ProtocolSession

Returns:

size of the pushed line handler

logout

void logout()

Logs out the session. Marks the connection for closure;

getSessionState

ImapSessionState getSessionState()

Gets the current client state.

Returns:

Returns the current state of this session.

authenticated

void authenticated()

Moves the session into ImapSessionState.AUTHENTICATED state.

selected

void selected(SelectedMailbox mailbox)

Moves this session into ImapSessionState.SELECTED state and sets the supplied mailbox to be the currently selected mailbox.

Parameters:

mailbox - The selected mailbox.

deselect

void deselect()

Moves the session out of ImapSessionState.SELECTED state and back into ImapSessionState.AUTHENTICATED state. The selected mailbox is cleared.

getSelected

SelectedMailbox getSelected()

Provides the selected mailbox for this session, or null if this session is not in ImapSessionState.SELECTED state.

Returns:

the currently selected mailbox.

isCompressionActive

boolean isCompressionActive()

Return true if compression is active

Returns:

compActive

isCompressionSupported

boolean isCompressionSupported()

Return true if compression is supported. This is related to COMPRESS extension. See http://www.ietf.org/rfc/rfc4978.txt

Returns:

compressSupport

startCompression

boolean startCompression()

Start the compression

Returns:

success

supportMultipleNamespaces

boolean supportMultipleNamespaces()

Return true if multiple namespaces are supported

Returns:

multipleNamespaces

isPlainAuthDisallowed

boolean isPlainAuthDisallowed()

Return true if the login / authentication via plain username / password is disallowed

Returns:

plainDisallowed