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  
23  /***
24   * Simplest Mailet which destroys any incoming messages.
25   *
26   */
27  public class Null extends GenericMailet {
28  
29      /***
30       * Set this mail to GHOST state, indicating that no further processing 
31       * should take place.
32       *
33       * @param mail the mail to process
34       */
35      public void service(Mail mail) {
36          mail.setState(Mail.GHOST);
37      }
38  
39      /***
40       * Return a string describing this mailet.
41       *
42       * @return a string describing this mailet
43       */
44      public String getMailetInfo() {
45          return "Null Mailet";
46      }
47  }
48