001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.geronimo.javamail.store.imap.connection;
019    
020    public interface IMAPUntaggedResponseHandler {
021        /**
022         * Handle an unsolicited untagged response receive back from a command.  This 
023         * will be any responses left over after the command has cherry picked the 
024         * bits that are relevent to the command just issued.  It is important 
025         * that the unsolicited response be reacted to in order to keep the message 
026         * caches in sync. 
027         * 
028         * @param response The response to handle.
029         * 
030         * @return true if the handle took care of the response and it should not be sent 
031         *         to additional handlers.  false if broadcasting of the response should continue.
032         */
033        public boolean handleResponse(IMAPUntaggedResponse response);
034    }