FileDocCategorySizeDatePackage
ICommandListservManager.javaAPI DocApache James 2.3.14523Fri Jan 12 12:56:28 GMT 2007org.apache.james.transport.mailets

ICommandListservManager

public interface ICommandListservManager implements org.apache.mailet.Mailet
ICommandListservManager is the interface that describes the functionality of any command based list serv managers. In order to obtain a reference to one, you can call:
ICommandListservManager mgr = (ICommandListservManager)mailetContext.getAttribute(ICommandListservManager.ID + listName);
version
CVS $Revision: 494012 $ $Date: 2007-01-08 11:23:58 +0100 (Mo, 08 Jan 2007) $
since
2.2.0

Fields Summary
public static final String
ID
Constructors Summary
Methods Summary
public org.apache.james.transport.mailets.listservcommands.IListServCommandgetCommand(java.lang.String name)
Get a specific command

param
name case in-sensitive
return
a {@link IListServCommand} if found, null otherwise

public org.apache.james.transport.mailets.listservcommands.IListServCommandgetCommandTarget(org.apache.mailet.MailAddress mailAddress)
Based on the to address get a valid or command or null

param
mailAddress
return
IListServCommand or null

public java.util.MapgetCommands()
Get all the available commands

return
a map of {@link IListServCommand}s

public java.lang.StringgetListDomain()
Get the domain of the list

return
a string like localhost

public java.lang.StringgetListName(boolean displayFormat)
Get the name of this list

param
displayFormat is whether you want a display version of this or not
return
the official display name of this list

public java.lang.StringgetListOwner()
Gets the owner of this list

return
this is an address like listOwner@localhost

public java.lang.StringgetResourcesFile()

return
the configuration file for the xml resources

public java.util.PropertiesgetStandardProperties()
Use this to get standard properties for future calls to {@link org.apache.james.util.XMLResources}

return
properties with the "LIST_NAME" and the "DOMAIN_NAME" properties

public org.apache.james.services.UsersRepositorygetUsersRepository()
Get the current user repository for this list serv

return
an instance of {@link UsersRepository} that is used for the member list of the list serv

public org.apache.james.util.XMLResources[]initXMLResources(java.lang.String[] names)
Initializes an array of resources

param
names such as 'header, footer' etc...
return
an initialized array of XMLResources
throws
org.apache.avalon.framework.configuration.ConfigurationException

public voidonError(org.apache.mailet.Mail mail, java.lang.String subject, java.lang.String errorMessage)
An error occurred, send some sort of message to the sender

param
subject the subject of the message to send
param
mail
param
errorMessage