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  
21  
22  package org.apache.james.transport.mailets;
23  
24  import org.apache.mailet.base.GenericMailet;
25  import org.apache.mailet.Mail;
26  import javax.mail.MessagingException;
27  
28  /**
29   * This mailet sets removes all attributes set on the Mail instance
30   * 
31   * Sample configuration:
32   * <pre><code>
33   * &lt;mailet match="All" class="RemoveAllMailAttributes"/&gt;
34   * </code></pre>
35   *
36   * @version CVS $Revision: 713949 $ $Date: 2008-11-14 07:40:21 +0000 (Fri, 14 Nov 2008) $
37   * @since 2.2.0
38   */
39  public class RemoveAllMailAttributes extends GenericMailet {
40      
41      /**
42       * Return a string describing this mailet.
43       *
44       * @return a string describing this mailet
45       */
46      public String getMailetInfo() {
47          return "Remove All Mail Attributes Mailet";
48      }
49  
50      /**
51       * Removes all attributes on the Mail
52       *
53       * @param mail the mail to process
54       *
55       * @throws MessagingException in all cases
56       */
57      public void service(Mail mail) throws MessagingException {
58          mail.removeAllAttributes ();
59      }
60      
61  
62  }