org.apache.mailet
Interface MatcherConfig

All Known Implementing Classes:

AbstractNetworkMatcher, AbstractQuotaMatcher, AbstractStorageQuota, All, AttachmentFileNameIs, CommandForListserv, CommandListservMatcher, CompareNumericHeaderValue, FetchedFrom, FileRegexMatcher, GenericMatcher, GenericRecipientMatcher, GenericRegexMatcher, HasAttachment, HasHabeasWarrantMark, HasHeader, HasMailAttribute, HasMailAttributeWithValue, HasMailAttributeWithValueRegex, HostIs, HostIsLocal, InSpammerBlacklist, IsInWhiteList, IsSingleRecipient, IsSMIMEEncrypted, IsSMIMESigned, IsX509CertificateSubject, MatcherConfigImpl, NESSpamCheck, RecipientIs, RecipientIsLocal, RecipientIsOverFixedQuota, RecipientIsRegex, RelayLimit, RemoteAddrInNetwork, RemoteAddrNotInNetwork, SenderHostIs, SenderInFakeDomain, SenderIs, SenderIsNull, SenderIsRegex, SizeGreaterThan, SMTPAuthSuccessful, SMTPAuthUserIs, SubjectIs, SubjectStartsWith, UserIs

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

Method Summary

java.lang.String	getCondition() The simple condition defined for this matcher, e.g., for SenderIs=admin@localhost, this would return admin@localhost.
MailetContext	getMailetContext() Returns a reference to the MailetContext in which the matcher is executing
java.lang.String	getMatcherName() Returns the name of this matcher instance.

Method Detail

getCondition

java.lang.String getCondition()

The simple condition defined for this matcher, e.g., for SenderIs=admin@localhost, this would return 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, used by the matcher to interact with its mailet container

getMatcherName

java.lang.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