FileDocCategorySizeDatePackage
IListServCommand.javaAPI DocApache James 2.3.13302Fri Jan 12 12:56:30 GMT 2007org.apache.james.transport.mailets.listservcommands

IListServCommand

public interface IListServCommand
IListServCommand is the interface that all pluggable list serv commands must implement. The lifecycle of a IListServCommand will be controlled by the {@link ICommandListservManager}

Requests sent to the CommandListservManager take the form of:
<listName>-<commandName>@domain
and if the commandName matches the command's name, then the {@link #onCommand} will be invoked.

A typical command is configured:
<command name="subscribe" class="Subscribe"/>


Typically, IListServCommands will format some text to reply with based off of resource files and calls to {@link org.apache.james.util.XMLResources#getString} This allows you to customize the messages sent by these commands by editing text files and not editing the javacode.
version
CVS $Revision: 494012 $ $Date: 2007-01-08 11:23:58 +0100 (Mo, 08 Jan 2007) $
since
2.2.0
see
ICommandListservManager

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetCommandName()
The name of this command specified by the 'name' parameter. eg:
<command name="subscribe" class="Subscribe"/>

return
the name of this command

public voidinit(org.apache.james.transport.mailets.ICommandListservManager commandListservManager, org.apache.avalon.framework.configuration.Configuration configuration)
Perform any required initialization

param
configuration
throws
ConfigurationException

public voidonCommand(org.apache.mailet.Mail mail)
Process this command to your hearts content

param
mail
throws
MessagingException