FileDocCategorySizeDatePackage
MailetConfig.javaAPI DocApache James 2.3.12987Fri Jan 12 12:56:34 GMT 2007org.apache.mailet

MailetConfig

public interface MailetConfig
A mailet configuration object used by a mailet container to pass information to a mailet during initialization.

The configuration information contains initialization parameters, which are a set of name/value pairs, and a MailetContext object, which gives the mailet information about the server.

version
1.0.0, 24/04/1999

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetInitParameter(java.lang.String name)
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

param
name - a String specifying the name of the initialization parameter
return
a String containing the value of the initialization parameter

public java.util.IteratorgetInitParameterNames()
Returns the names of the mailet's initialization parameters as an Iterator of String objects, or an empty Iterator if the mailet has no initialization parameters.

return
an Iterator of String objects containing the names of the mailet's initialization parameters

public MailetContextgetMailetContext()
Returns a reference to the MailetContext in which the mailet is executing.

return
a MailetContext object, used by the mailet to interact with its mailet container

public java.lang.StringgetMailetName()
Returns the name of this mailet instance. The name may be provided via server administration, assigned in the application deployment descriptor, or for an unregistered (and thus unnamed) mailet instance it will be the mailet's class name.

return
the name of the mailet instance