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.commons.net.pop3;
019    
020    /***
021     * POP3Command stores POP3 command code constants.
022     * <p>
023     * <p>
024     * @author Daniel F. Savarese
025     ***/
026    
027    public final class POP3Command
028    {
029        /*** Send user name. ***/
030        public static final int USER = 0;
031        /*** Send password. ***/
032        public static final int PASS = 1;
033        /*** Quit session. ***/
034        public static final int QUIT = 2;
035        /*** Get status. ***/
036        public static final int STAT = 3;
037        /*** List message(s). ***/
038        public static final int LIST = 4;
039        /*** Retrieve message(s). ***/
040        public static final int RETR = 5;
041        /*** Delete message(s). ***/
042        public static final int DELE = 6;
043        /*** No operation.  Used as a session keepalive. ***/
044        public static final int NOOP = 7;
045        /*** Reset session. ***/
046        public static final int RSET = 8;
047        /*** Authorization. ***/
048        public static final int APOP = 9;
049        /*** Retrieve top number lines from message. ***/
050        public static final int TOP = 10;
051        /*** List unique message identifier(s). ***/
052        public static final int UIDL = 11;
053    
054        static final String[] _commands = {
055                                              "USER", "PASS", "QUIT", "STAT", "LIST", "RETR", "DELE", "NOOP", "RSET",
056                                              "APOP", "TOP", "UIDL"
057                                          };
058    
059        // Cannot be instantiated.
060        private POP3Command()
061        {}
062    
063        /***
064         * Get the POP3 protocol string command corresponding to a command code.
065         * <p>
066         * @return The POP3 protocol string command corresponding to a command code.
067         ***/
068        public static final String getCommand(int command)
069        {
070            return _commands[command];
071        }
072    }