Package com.icegreen.greenmail.imap.commands

Class QuotaCommand

java.lang.Object

com.icegreen.greenmail.imap.commands.QuotaCommand

All Implemented Interfaces:

ImapCommand, ImapConstants

Direct Known Subclasses:

QuotaRootCommand

public class QuotaCommand
extends Object

Implements IMAP Quota Extension. See rfc2087

Author:

mm

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	log
static String	NAME
protected CommandParser	parser

Fields inherited from interface com.icegreen.greenmail.imap.ImapConstants

BAD, BYE, HIERARCHY_DELIMITER, HIERARCHY_DELIMITER_CHAR, INBOX_NAME, MESSAGES, NAMESPACE_PREFIX, NAMESPACE_PREFIX_CHAR, NO, OK, SP, STORAGE, UNTAGGED, USER_NAMESPACE, VERSION

Constructor Summary

Constructors

Constructor	Description
QuotaCommand(String name)

Method Summary

Modifier and Type	Method	Description
protected void	appendQuota(jakarta.mail.Quota quota, StringBuilder buf)
protected void	appendQuotaRootName(jakarta.mail.Quota quota, StringBuilder buf)
protected void	doProcess(ImapRequestLineReader request, ImapResponse response, ImapSession session)	This is the method overridden by specific command implementations to perform commend-specific processing.
protected String	getArgSyntax()	Provides the syntax for the command arguments if any.
protected String	getExpectedMessage()	Provides a message which describes the expected format and arguments for this command.
protected MailFolder	getMailbox(String mailboxName, ImapSession session, boolean mustExist)
String	getName()
CommandParser	getParser()
void	process(ImapRequestLineReader request, ImapResponse response, ImapSession session)	Template methods for handling command processing.
boolean	validForState(ImapSessionState state)	Check that the state is ImapSessionState.AUTHENTICATED or ImapSessionState.SELECTED

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

log

protected final org.slf4j.Logger log

parser

protected CommandParser parser

Constructor Detail

QuotaCommand

public QuotaCommand(String name)

Method Detail

doProcess

protected void doProcess(ImapRequestLineReader request,
                         ImapResponse response,
                         ImapSession session)
                  throws ProtocolException,
                         FolderException,
                         AuthorizationException

This is the method overridden by specific command implementations to perform commend-specific processing.

Parameters:

request - The client request

response - The server response

session - The current client session

Throws:

ProtocolException

FolderException

AuthorizationException

appendQuota

protected void appendQuota(jakarta.mail.Quota quota,
                           StringBuilder buf)

appendQuotaRootName

protected void appendQuotaRootName(jakarta.mail.Quota quota,
                                   StringBuilder buf)

validForState

public boolean validForState(ImapSessionState state)

Check that the state is ImapSessionState.AUTHENTICATED or ImapSessionState.SELECTED

Specified by:

validForState in interface ImapCommand

Parameters:

state - The current state of the ImapSession

Returns:

true if the command is valid in this state.

See Also:

ImapCommand.validForState(com.icegreen.greenmail.imap.ImapSessionState)

process

public void process(ImapRequestLineReader request,
                    ImapResponse response,
                    ImapSession session)

Template methods for handling command processing. This method reads argument values (validating them), and checks the request for correctness. If correct, the command processing is delegated to the specific command implementation.

Specified by:

process in interface ImapCommand

Parameters:

request - The current client request

response - The current server response

session - The current session

See Also:

ImapCommand.process(com.icegreen.greenmail.imap.ImapRequestLineReader, com.icegreen.greenmail.imap.ImapResponse, com.icegreen.greenmail.imap.ImapSession)

getExpectedMessage

protected String getExpectedMessage()

Provides a message which describes the expected format and arguments for this command. This is used to provide user feedback when a command request is malformed.

Returns:

A message describing the command protocol format.

getArgSyntax

protected final String getArgSyntax()

Provides the syntax for the command arguments if any. This value is used to provide user feedback in the case of a malformed request.

For commands which do not allow any arguments, null should be returned.

Returns:

The syntax for the command arguments, or null for commands without arguments.

getMailbox

protected MailFolder getMailbox(String mailboxName,
                                ImapSession session,
                                boolean mustExist)
                         throws FolderException

Throws:

FolderException

getParser

public CommandParser getParser()

getName

public final String getName()

Specified by:

getName in interface ImapCommand

Returns:

the name of the command, as specified in rfc2060.