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

MatcherConfig

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

The configuration information contains an initialization parameter, which is set as a condition String, and a MailetContext object, which gives the mailet information about the mailet container.

version
1.0.0, 24/04/1999

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetCondition()
The simple condition defined for this matcher, e.g., for SenderIs=admin@localhost, this would return admin@localhost.

return
a String containing the value of the initialization parameter

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

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

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

return
the name of the matcher instance