org.apache.mailet
Interface MailetConfig

All Known Implementing Classes:

GenericMailet, MailetConfigImpl

public interface MailetConfig

A mailet configuration object used by a mailet container used 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

Author:

Serge Knystautas

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.

Method Detail

getInitParameter

public String getInitParameter(String name)

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

Returns:

a String containing the value of the initialization parameter

getInitParameterNames

public 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.

Returns:

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

getMailetContext

public MailetContext getMailetContext()

Returns a reference to the MailetContext in which the mailet is executing.

Returns:

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

getMailetName

public String getMailetName()

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.

Returns:

the name of the mailet instance