org.apache.mailet
Interface MatcherConfig

All Known Implementing Classes:

AbstractQuotaMatcher, All, AttachmentFileNameIs, CommandForListserv, CommandListservMatcher, CompareNumericHeaderValue, FetchedFrom, FileRegexMatcher, GenericMatcher, GenericRecipientMatcher, GenericRegexMatcher, HasAttachment, HasHabeasWarrantMark, HasHeader, HasMailAttribute, HasMailAttributeWithValue, HasMailAttributeWithValueRegex, HostIs, HostIsLocal, IsSingleRecipient, IsSMIMEEncrypted, IsSMIMESigned, IsX509CertificateSubject, NESSpamCheck, RecipientIs, RecipientIsLocal, RecipientIsRegex, RelayLimit, SenderHostIs, SenderHostIsLocal, SenderIs, SenderIsLocal, SenderIsNull, SenderIsRegex, SizeGreaterThan, SMTPAuthSuccessful, SMTPAuthUserIs, SMTPIsAuthNetwork, SubjectIs, SubjectStartsWith, UserIs

public interface MatcherConfig

A matcher configuration object used by the mailet container to pass information to a matcher during initialization.

The configuration information consists of the matcher's condition string, and a MailetContext object which allows the matcher to interact with the mailet container.

Method Summary

String	getCondition() The condition defined for this matcher.
MailetContext	getMailetContext() Returns a reference to the MailetContext in which the matcher is executing
String	getMatcherName() Returns the name of this matcher instance.

Method Detail

getCondition

String getCondition()

The condition defined for this matcher.

For example, the SenderIs matcher might be configured as "SenderIs=admin@localhost", in which case the condition would be "admin@localhost".

Returns:

a String containing the value of the initialization parameter

getMailetContext

MailetContext getMailetContext()

Returns a reference to the MailetContext in which the matcher is executing

Returns:

a MailetContext object which can be used by the matcher to interact with the mailet container

getMatcherName

String getMatcherName()

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.

Returns:

the name of the matcher instance