| org.apache.mailet.MailetConfig
All known Subclasses: org.apache.james.core.MailetConfigImpl, org.apache.mailet.GenericMailet, org.apache.james.test.mock.mailet.MockMailetConfig,
MailetConfig | public interface MailetConfig (Code) | | 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 |
Method Summary | |
String | getInitParameter(String name) Returns a String containing the value of the named initialization
parameter, or null if the parameter does not exist. | Iterator | getInitParameterNames() 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. | MailetContext | getMailetContext() Returns a reference to the MailetContext in which the mailet is
executing. | String | getMailetName() Returns the name of this mailet instance. |
getInitParameter | String getInitParameter(String name)(Code) | | Returns a String containing the value of the named initialization
parameter, or null if the parameter does not exist.
Parameters: name - - a String specifying the name of the initialization parameter a String containing the value of the initialization parameter |
getInitParameterNames | Iterator getInitParameterNames()(Code) | | 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.
an Iterator of String objects containing the names of the mailet'sinitialization parameters |
getMailetContext | MailetContext getMailetContext()(Code) | | Returns a reference to the MailetContext in which the mailet is
executing.
a MailetContext object, used by the mailet to interact with itsmailet container |
getMailetName | String getMailetName()(Code) | | 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.
the name of the mailet instance |
|
|