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
23 import org.apache.mailet.GenericMatcher;
24 import org.apache.mailet.Mail;
25 import org.apache.mailet.MatcherConfig;
26 import java.util.Collection;
27 import javax.mail.MessagingException;
28
29 /***
30 * <P>This Matcher determines if the mail contains the attribute specified in the
31 * condition, and returns all recipients if it is the case.</P>
32 * <P>Sample configuration:</P>
33 * <PRE><CODE>
34 * <mailet match="HasMailAttribute=whatever" class="<any-class>">
35 * </CODE></PRE>
36 *
37 * @version CVS $Revision: 494012 $ $Date: 2007-01-08 10:23:58 +0000 (Mon, 08 Jan 2007) $
38 * @since 2.2.0
39 **/
40 public class HasMailAttribute extends GenericMatcher
41 {
42
43 private String attributeName;
44
45 /***
46 * Return a string describing this matcher.
47 *
48 * @return a string describing this matcher
49 */
50 public String getMatcherInfo() {
51 return "Has Mail Attribute Matcher";
52 }
53
54 public void init (MatcherConfig conf) throws MessagingException
55 {
56 attributeName = conf.getCondition();
57 }
58
59 /***
60 * @param mail the mail to check.
61 * @return all recipients if the condition is the name of an attribute
62 * set on the mail
63 *
64 **/
65 public Collection match (Mail mail) throws MessagingException
66 {
67 if (mail.getAttribute (attributeName) != null) {
68 return mail.getRecipients();
69 }
70 return null;
71 }
72
73 }