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 018package org.apache.commons.net.pop3; 019 020/** 021 * POP3Command stores POP3 command code constants. 022 * 023 * 024 */ 025 026public final class POP3Command { 027 /** Send user name. */ 028 public static final int USER = 0; 029 /** Send password. */ 030 public static final int PASS = 1; 031 /** Quit session. */ 032 public static final int QUIT = 2; 033 /** Get status. */ 034 public static final int STAT = 3; 035 /** List message(s). */ 036 public static final int LIST = 4; 037 /** Retrieve message(s). */ 038 public static final int RETR = 5; 039 /** Delete message(s). */ 040 public static final int DELE = 6; 041 /** No operation. Used as a session keepalive. */ 042 public static final int NOOP = 7; 043 /** Reset session. */ 044 public static final int RSET = 8; 045 /** Authorization. */ 046 public static final int APOP = 9; 047 /** Retrieve top number lines from message. */ 048 public static final int TOP = 10; 049 /** List unique message identifier(s). */ 050 public static final int UIDL = 11; 051 /** 052 * The capabilities command. 053 * 054 * @since 3.0 055 */ 056 public static final int CAPA = 12; 057 /** 058 * Authentication 059 * 060 * @since 3.0 061 */ 062 public static final int AUTH = 13; 063 064 private static final int NEXT = AUTH + 1; // update as necessary when adding new entries 065 066 static final String[] commands = { "USER", "PASS", "QUIT", "STAT", "LIST", "RETR", "DELE", "NOOP", "RSET", "APOP", "TOP", "UIDL", "CAPA", "AUTH", }; 067 068 static { 069 if (commands.length != NEXT) { 070 throw new RuntimeException("Error in array definition"); 071 } 072 } 073 074 /** 075 * Get the POP3 protocol string command corresponding to a command code. 076 * 077 * @param command the command code 078 * 079 * @return The POP3 protocol string command corresponding to a command code. 080 */ 081 public static String getCommand(final int command) { 082 return commands[command]; 083 } 084 085 // Cannot be instantiated. 086 private POP3Command() { 087 } 088}