View Javadoc

    1   /*
    2    * Copyright 2001-2005 The Apache Software Foundation
    3    *
    4    * Licensed under the Apache License, Version 2.0 (the "License");
    5    * you may not use this file except in compliance with the License.
    6    * You may obtain a copy of the License at
    7    *
    8    *     http://www.apache.org/licenses/LICENSE-2.0
    9    *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  package org.apache.commons.net.smtp;
    17
    18  /****
    19   * SMTPCommand stores a set of constants for SMTP command codes.  To interpret
    20   * the meaning of the codes, familiarity with RFC 821 is assumed.
    21   * The mnemonic constant names are transcriptions from the code descriptions
    22   * of RFC 821.  For those who think in terms of the actual SMTP commands,
    23   * a set of constants such as {@link #HELO  HELO } are provided
    24   * where the constant name is the same as the SMTP command.
    25   * <p>
    26   * <p>
    27   * @author Daniel F. Savarese
    28   ***/
    29
    30  public final class SMTPCommand
    31  {
    32
    33
    34      public static final int HELO = 0;
    35      public static final int MAIL = 1;
    36      public static final int RCPT = 2;
    37      public static final int DATA = 3;
    38      public static final int SEND = 4;
    39      public static final int SOML = 5;
    40      public static final int SAML = 6;
    41      public static final int RSET = 7;
    42      public static final int VRFY = 8;
    43      public static final int EXPN = 9;
    44      public static final int HELP = 10;
    45      public static final int NOOP = 11;
    46      public static final int TURN = 12;
    47      public static final int QUIT = 13;
    48
    49      public static final int HELLO = HELO;
    50      public static final int LOGIN = HELO;
    51      public static final int MAIL_FROM = MAIL;
    52      public static final int RECIPIENT = RCPT;
    53      public static final int SEND_MESSAGE_DATA = DATA;
    54      public static final int SEND_FROM = SEND;
    55      public static final int SEND_OR_MAIL_FROM = SOML;
    56      public static final int SEND_AND_MAIL_FROM = SAML;
    57      public static final int RESET = RSET;
    58      public static final int VERIFY = VRFY;
    59      public static final int EXPAND = EXPN;
    60      // public static final int HELP = HELP;
    61      // public static final int NOOP = NOOP;
    62      // public static final int TURN = TURN;
    63      // public static final int QUIT = QUIT;
    64      public static final int LOGOUT = QUIT;
    65
    66      // Cannot be instantiated
    67      private SMTPCommand()
    68      {}
    69
    70      static final String[] _commands = {
    71                                            "HELO", "MAIL FROM:", "RCPT TO:", "DATA", "SEND FROM:", "SOML FROM:",
    72                                            "SAML FROM:", "RSET", "VRFY", "EXPN", "HELP", "NOOP", "TURN", "QUIT"
    73                                        };
    74
    75
    76      /****
    77       * Retrieve the SMTP protocol command string corresponding to a specified
    78       * command code.
    79       * <p>
    80       * @param command The command code.
    81       * @return The SMTP protcol command string corresponding to a specified
    82       *         command code.
    83       ***/
    84      public static final String getCommand(int command)
    85      {
    86          return _commands[command];
    87      }
    88
    89  }