View Javadoc

1   /************************************************************************
2    * Copyright (c) 2000-2006 The Apache Software Foundation.             *
3    * All rights reserved.                                                *
4    * ------------------------------------------------------------------- *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you *
6    * may not use this file except in compliance with the License. You    *
7    * may obtain a copy of the License at:                                *
8    *                                                                     *
9    *     http://www.apache.org/licenses/LICENSE-2.0                      *
10   *                                                                     *
11   * Unless required by applicable law or agreed to in writing, software *
12   * distributed under the License is distributed on an "AS IS" BASIS,   *
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or     *
14   * implied.  See the License for the specific language governing       *
15   * permissions and limitations under the License.                      *
16   ***********************************************************************/
17  
18  package org.apache.james.transport.matchers;
19  
20  import org.apache.mailet.GenericMatcher;
21  import org.apache.mailet.Mail;
22  import org.apache.mailet.MailAddress;
23  
24  import java.util.Collection;
25  import java.util.StringTokenizer;
26  
27  /***
28   * <P>Matches mails that are sent by an SMTP authenticated user.</P>
29   * <P>If the sender was not authenticated it will not match.</P>
30   * <PRE><CODE>
31   * &lt;mailet match=&quot;SMTPAuthSuccessful&quot; class=&quot;&lt;any-class&gt;&quot;&gt;
32   * </CODE></PRE>
33   *
34   * @version CVS $Revision: 365582 $ $Date: 2006-01-03 08:51:21 +0000 (mar, 03 gen 2006) $
35   * @since 2.2.0
36   */
37  public class SMTPAuthSuccessful extends GenericMatcher {
38      
39      /***
40       * The mail attribute holding the SMTP AUTH user name, if any.
41       */
42      private final static String SMTP_AUTH_USER_ATTRIBUTE_NAME = "org.apache.james.SMTPAuthUser";
43      
44      public Collection match(Mail mail) {
45          String authUser = (String) mail.getAttribute(SMTP_AUTH_USER_ATTRIBUTE_NAME);
46          if (authUser != null) {
47              return mail.getRecipients();
48          } else {
49              return null;
50          }
51      }
52  }