org.apache.james.mailet.standard.matchers
Class RecipientIsRegex

java.lang.Object
  extended by org.apache.mailet.base.GenericMatcher
      extended by org.apache.mailet.base.GenericRecipientMatcher
          extended by org.apache.james.mailet.standard.matchers.RecipientIsRegex
All Implemented Interfaces:
Matcher, MatcherConfig

public class RecipientIsRegex
extends GenericRecipientMatcher

Matches recipients whose address matches a regular expression.

Is equivalent to the SenderIsRegex matcher but matching on the recipient.

Configuration string: a regular expression.


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

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


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

Version:
CVS $Revision$ $Date$

Constructor Summary
RecipientIsRegex()
           
 
Method Summary
 void init()
          A convenience method which can be overridden so that there's no need to call super.init(config).
 boolean matchRecipient(MailAddress recipient)
          Simple check to match exclusively on the email address (not message information).
 
Methods inherited from class org.apache.mailet.base.GenericRecipientMatcher
match
 
Methods inherited from class org.apache.mailet.base.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

RecipientIsRegex

public RecipientIsRegex()
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 - if an exception occurs that interrupts the matcher's normal operation

matchRecipient

public boolean matchRecipient(MailAddress recipient)
Description copied from class: GenericRecipientMatcher
Simple check to match exclusively on the email address (not message information).

Specified by:
matchRecipient in class GenericRecipientMatcher
Parameters:
recipient - - the address to determine whether to match
Returns:
boolean whether the recipient is a match


Copyright © 2008-2012 The Apache Software Foundation. All Rights Reserved.