View Javadoc

1   /*****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.james.transport.matchers;
21  
22  import org.apache.mailet.GenericMatcher;
23  import org.apache.mailet.Mail;
24  import org.apache.mailet.MailAddress;
25  
26  import java.util.Collection;
27  import java.util.StringTokenizer;
28  
29  /***
30   * <P>Matches mails that are sent by an SMTP authenticated user present in a supplied list.</P>
31   * <P>If the sender was not authenticated it will not match.</P>
32   * <P>Configuration string: a comma, tab or space separated list of James users.</P>
33   * <PRE><CODE>
34   * &lt;mailet match=&quot;SMTPAuthUserIs=&lt;list-of-user-names&gt;&quot; class=&quot;&lt;any-class&gt;&quot;&gt;
35   * </CODE></PRE>
36   *
37   * @version CVS $Revision: 494012 $ $Date: 2007-01-08 10:23:58 +0000 (lun, 08 gen 2007) $
38   * @since 2.2.0
39   */
40  public class SMTPAuthUserIs extends GenericMatcher {
41      
42      /***
43       * The mail attribute holding the SMTP AUTH user name, if any.
44       */
45      private final static String SMTP_AUTH_USER_ATTRIBUTE_NAME = "org.apache.james.SMTPAuthUser";
46      
47      private Collection users;
48  
49      public void init() throws javax.mail.MessagingException {
50          StringTokenizer st = new StringTokenizer(getCondition(), ", \t", false);
51          users = new java.util.HashSet();
52          while (st.hasMoreTokens()) {
53              users.add(st.nextToken());
54          }
55      }
56  
57      public Collection match(Mail mail) {
58          String authUser = (String) mail.getAttribute(SMTP_AUTH_USER_ATTRIBUTE_NAME);
59          if (authUser != null && users.contains(authUser)) {
60              return mail.getRecipients();
61          } else {
62              return null;
63          }
64      }
65  }