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  package org.apache.jsieve.mailet;
20  
21  import javax.mail.MessagingException;
22  
23  import org.apache.jsieve.mail.Action;
24  import org.apache.jsieve.mail.ActionFileInto;
25  import org.apache.jsieve.mail.ActionKeep;
26  import org.apache.mailet.Mail;
27  
28  /**
29   * Performs the filing of a mail into the inbox. 
30   * <h4>Thread Safety</h4>
31   * <p>An instance maybe safe accessed concurrently by multiple threads.</p>
32   */
33  public class KeepAction extends FileIntoAction implements MailAction {
34      
35      private static final String INBOX = "INBOX";
36  
37      public void execute(Action action, Mail mail, ActionContext context)
38              throws MessagingException {
39          if (action instanceof ActionKeep) {
40              final ActionKeep actionKeep = (ActionKeep) action;
41              execute(actionKeep, mail, context);
42          }
43      }
44  
45      /**
46       * <p>
47       * Executes the passed ActionKeep.
48       * </p>
49       * 
50       * <p>
51       * In this implementation, "keep" is equivalent to "fileinto" with a
52       * destination of "INBOX".
53       * </p>
54       * 
55       * @param anAction not null
56       * @param aMail not null
57       * @param context not null
58       * @throws MessagingException
59       */
60      public void execute(ActionKeep anAction, Mail aMail, ActionContext context) throws MessagingException
61      {
62          final ActionFileInto action = new ActionFileInto(INBOX);
63          execute(action, aMail, context);
64      }
65  }