/****************************************************************
 * 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.james.imap.api.message.request;

/**
 * Represent ESEARCH result options. See RFC4731 and RFC5182
 *
 */
public enum SearchResultOption {
    /**
     * Return all matched message uids formatted as sequence-set
     */
    ALL,
    
    /**
     * Return the minimum uid matched 
     */
    MIN,
    
    /**
     * Return the maximum uid matched
     */
    MAX,
    
    /**
     * Return the count of matched messages
     */
    COUNT,
    
    /**
     * Save the last ESEARCH returned sequence-set's. 
     * 
     * See RFC5182 2.4. Interaction with ESEARCH Extension
     */
    SAVE
}
