org.apache.james.transport.matchers
Class SMTPAuthUserIs

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

All Implemented Interfaces:

Matcher, MatcherConfig

public class SMTPAuthUserIs
extends GenericMatcher

Matches mails that are sent by an SMTP authenticated user present in a supplied list.

If the sender was not authenticated it will not match.

Configuration string: a comma, tab or space separated list of James users.

 <mailet match="SMTPAuthUserIs=<list-of-user-names>" class="<any-class>">
 

Since:

2.2.0

Version:

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

Constructor Summary

SMTPAuthUserIs()

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

SMTPAuthUserIs

public SMTPAuthUserIs()

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.