public interface IMAPSession extends ProtocolSession
ProtocolSession.State
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
|
getAttachment, getCharset, getConfiguration, getConnectionState, getLineDelimiter, getLocalAddress, getLogger, getRemoteAddress, getSessionID, getState, getUser, isStartTLSSupported, isTLSStarted, newFatalErrorResponse, newLineTooLongResponse, pushLineHandler, resetState, setAttachment, setUser
void popLineHandler()
popLineHandler
in interface ProtocolSession
int getPushedLineHandlerCount()
LineHandler
getPushedLineHandlerCount
in interface ProtocolSession
void logout()
ImapSessionState getSessionState()
void authenticated()
ImapSessionState.AUTHENTICATED
state.void selected(SelectedMailbox mailbox)
ImapSessionState.SELECTED
state and sets
the supplied mailbox to be the currently selected mailbox.mailbox
- The selected mailbox.void deselect()
ImapSessionState.SELECTED
state and back
into ImapSessionState.AUTHENTICATED
state. The selected mailbox
is cleared.SelectedMailbox getSelected()
null
if
this session is not in ImapSessionState.SELECTED
state.boolean isCompressionActive()
boolean isCompressionSupported()
boolean startCompression()
boolean supportMultipleNamespaces()
boolean isPlainAuthDisallowed()
Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.