org.apache.james.transport.matchers
Class HasMailAttributeWithValueRegex

java.lang.Object
  org.apache.mailet.base.GenericMatcher
      org.apache.james.transport.matchers.HasMailAttributeWithValueRegex

All Implemented Interfaces:

org.apache.mailet.Matcher, org.apache.mailet.MatcherConfig

public class HasMailAttributeWithValueRegex
extends org.apache.mailet.base.GenericMatcher

This Matcher determines if the mail contains the attribute specified in the condition and that attribute matches the supplied regular expression, it returns all recipients if that is the case.

Sample configuration:

 <mailet match="HasMailAttributeWithValueRegex=whatever," class="<any-class>">
 

Note: as it is not possible to put arbitrary objects in the configuration, toString() is called on the attribute value, and that is the value matched against.

Since:

2.2.0

Version:

CVS $Revision: 717869 $ $Date: 2008-11-15 15:56:18 +0000 (Sat, 15 Nov 2008) $

Constructor Summary

HasMailAttributeWithValueRegex()

Method Summary

java.lang.String	getMatcherInfo() Return a string describing this matcher.
void	init(org.apache.mailet.MatcherConfig conf)
java.util.Collection	match(org.apache.mailet.Mail mail)

Methods inherited from class org.apache.mailet.base.GenericMatcher

destroy, getCondition, getMailetContext, getMatcherConfig, getMatcherName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HasMailAttributeWithValueRegex

public HasMailAttributeWithValueRegex()

Method Detail

getMatcherInfo

public java.lang.String getMatcherInfo()

Return a string describing this matcher.

Specified by:

getMatcherInfo in interface org.apache.mailet.Matcher

Overrides:

getMatcherInfo in class org.apache.mailet.base.GenericMatcher

Returns:

a string describing this matcher

init

public void init(org.apache.mailet.MatcherConfig conf)
          throws javax.mail.MessagingException

Specified by:

init in interface org.apache.mailet.Matcher

Overrides:

init in class org.apache.mailet.base.GenericMatcher

Throws:

javax.mail.MessagingException

match

public java.util.Collection match(org.apache.mailet.Mail mail)
                           throws javax.mail.MessagingException

Specified by:

match in interface org.apache.mailet.Matcher

Specified by:

match in class org.apache.mailet.base.GenericMatcher

Parameters:

mail - the mail to check.

Returns:

all recipients if the part of the condition prior to the first equalsign is the name of an attribute set on the mail and the part of the condition after interpreted as a regular expression matches the toString value of the corresponding attributes value.

Throws:

javax.mail.MessagingException