core/src/main/java/org/apache/jsieve/commands/Discard.java

   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.jsieve.commands;
  21
  22 import org.apache.jsieve.Arguments;
  23 import org.apache.jsieve.Block;
  24 import org.apache.jsieve.SieveContext;
  25 import org.apache.jsieve.exception.SieveException;
  26 import org.apache.jsieve.mail.ActionDiscard;
  27 import org.apache.jsieve.mail.MailAdapter;
  28
  29 /**
  30  * Class Discard implements the Discard Command as defined in RFC 3028, section
  31  * 4.5.
  32  */
  33 public class Discard extends AbstractActionCommand {
  34
  35     /**
  36      * Constructor for Discard.
  37      */
  38     public Discard() {
  39         super();
  40     }
  41
  42     /**
  43      * <p>
  44      * Discard silently discards a Mail by cancelling the implicit keep as
  45      * specified in RFC 3028, Section 4.5.
  46      * </p>
  47      * <p>
  48      *
  49      * @see org.apache.jsieve.commands.AbstractCommand#executeBasic(MailAdapter,
  50      *      Arguments, Block, SieveContext)
  51      *      </p>
  52      */
  53     protected Object executeBasic(MailAdapter mail, Arguments arguments,
  54             Block block, SieveContext context) throws SieveException {
  55         // Just cancels the implicit keep
  56         // See http://tools.ietf.org/html/rfc5228#section-4.4
  57         context.getCommandStateManager().setImplicitKeep(false);
  58
  59         mail.addAction(new ActionDiscard());
  60
  61         return null;
  62     }
  63
  64 }