org.apache.james.transport.matchers
Class SenderIsRegex

java.lang.Object
  org.apache.mailet.GenericMatcher
      org.apache.james.transport.matchers.SenderIsRegex

All Implemented Interfaces:

Matcher, MatcherConfig

public class SenderIsRegex
extends GenericMatcher

Matches mails that are sent by a sender whose address matches a regular expression.

Is equivalent to the RecipientIsRegex matcher but matching on the sender.

Configuration string: a regular expression.

 <mailet match="SenderIsRegex=<regular-expression>" class="<any-class>">
 

The example below will match any sender in the format user@log.anything

 <mailet match="SenderIsRegex=(.*)@log\.(.*)" class="<any-class>">
 </mailet>
 

Another example below will match any sender having some variations of the string mp3 inside the username part.

 <mailet match="SenderIsRegex=(.*)(mp3|emmepitre)(.*)@" class="<any-class>">
 </mailet>
 

Since:

2.2.0

Version:

CVS $Revision: 494012 $ $Date: 2007-01-08 10:23:58 +0000 (lun, 08 gen 2007) $

Constructor Summary

SenderIsRegex()

Method Summary

void	init() A convenience method which can be overridden so that there's no need to call super.init(config).
java.util.Collection	match(Mail mail) Called by the matcher container to allow the matcher to process a message.

Methods inherited from class org.apache.mailet.GenericMatcher

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderIsRegex

public SenderIsRegex()

Method Detail

init

public void init()
          throws javax.mail.MessagingException

Description copied from class: GenericMatcher

A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding init(MatcherConfig), simply override this method and it will be called by GenericMatcher.init(MatcherConfig config). The MatcherConfig object can still be retrieved via getMatcherConfig().

Overrides:

init in class GenericMatcher

Throws:

javax.mail.MessagingException

match

public java.util.Collection match(Mail mail)

Description copied from class: GenericMatcher

Called by the matcher container to allow the matcher to process a message.

This method is declared abstract so subclasses must override it.

Specified by:

match in interface Matcher

Specified by:

match in class GenericMatcher

Parameters:

mail - - the Mail object that contains the MimeMessage and routing information

Returns:

java.util.Collection - the recipients that the mailet container should have the mailet affect.