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