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