org.apache.jsieve.commands.optional.FileInto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apache-jsieve Show documentation
Apache jSieve is a server side mail filtering system implementing RFC3028. Apache jSieve is developed by the JAMES project.
There is a newer version: 0.8
Show newest version
/****************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one   *
 * or more contributor license agreements.  See the NOTICE file *
 * distributed with this work for additional information        *
 * regarding copyright ownership.  The ASF licenses this file   *
 * to you under the Apache License, Version 2.0 (the            *
 * "License"); you may not use this file except in compliance   *
 * with the License.  You may obtain a copy of the License at   *
 *                                                              *
 *   http://www.apache.org/licenses/LICENSE-2.0                 *
 *                                                              *
 * Unless required by applicable law or agreed to in writing,   *
 * software distributed under the License is distributed on an  *
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
 * KIND, either express or implied.  See the License for the    *
 * specific language governing permissions and limitations      *
 * under the License.                                           *
 ****************************************************************/

package org.apache.jsieve.commands.optional;

import java.util.ListIterator;

import org.apache.jsieve.Arguments;
import org.apache.jsieve.Block;
import org.apache.jsieve.SieveContext;
import org.apache.jsieve.StringListArgument;
import org.apache.jsieve.commands.AbstractActionCommand;
import org.apache.jsieve.exception.SieveException;
import org.apache.jsieve.mail.Action;
import org.apache.jsieve.mail.ActionFileInto;
import org.apache.jsieve.mail.MailAdapter;

/**
 * Class FileInto implements the FileInto Command as defined in RFC 3028,
 * section 4.2.
 */
public class FileInto extends AbstractActionCommand {

    /**
     * Constructor for Require.
     */
    public FileInto() {
        super();
    }

    /**
     * 
     * Add an ActionFileInto to the List of Actions to be performed passing the
     * sole StringList argument as the destination. RFC 3028 mandates that there
     * should be only one FileInto per destination. If this is a duplicate, this
     * Command is silently ignored.
     * 
     * 
     * Also,
     * 
     * @see org.apache.jsieve.commands.AbstractCommand#executeBasic(MailAdapter,
     *      Arguments, Block, SieveContext)
     *      
     */
    protected Object executeBasic(MailAdapter mail, Arguments arguments,
            Block block, SieveContext context) throws SieveException {
        String destination = (String) ((StringListArgument) arguments
                .getArgumentList().get(0)).getList().get(0);

        // Only one fileinto per destination allowed, others should be
        // discarded
        ListIterator actionsIter = mail.getActionsIterator();
        boolean isDuplicate = false;
        while (actionsIter.hasNext()) {
            Action action = (Action) actionsIter.next();
            isDuplicate = (action instanceof ActionFileInto)
                    && (((ActionFileInto) action).getDestination()
                            .equals(destination));
        }

        if (!isDuplicate)
            mail.addAction(new ActionFileInto(destination));

        return null;
    }

    /**
     * @see org.apache.jsieve.commands.AbstractCommand#validateArguments(Arguments,
     *      SieveContext)
     */
    protected void validateArguments(Arguments arguments, SieveContext context)
            throws SieveException {
        validateSingleStringArguments(arguments, context);
    }

}