Enum IMAPCommand

java.lang.Object
java.lang.Enum<IMAPCommand>
org.apache.commons.net.imap.IMAPCommand
All Implemented Interfaces:
Serializable, Comparable<IMAPCommand>

public enum IMAPCommand extends Enum<IMAPCommand>
IMAPCommand stores IMAP command codes.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Valid in authenticated state.
    Valid in Not Authenticated state
    Valid in any state.
    Valid in selected state (substate of authenticated).
    Valid in selected state (substate of authenticated).
    Valid in selected state (substate of authenticated).
    Valid in authenticated state.
    Valid in authenticated state.
    Valid in authenticated state.
    Valid in selected state (substate of authenticated).
    Valid in selected state (substate of authenticated).
    Valid in authenticated state.
    Valid in Not Authenticated state
    Valid in any state.
    Valid in authenticated state.
    Valid in any state.
    Valid in authenticated state.
    Valid in selected state (substate of authenticated).
    Valid in authenticated state.
    Valid in Not Authenticated state
    Valid in authenticated state.
    Valid in selected state (substate of authenticated).
    Valid in authenticated state.
    Valid in selected state (substate of authenticated).
    Valid in authenticated state.
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static final String
    Gets the IMAP protocol string command corresponding to a command code.
    Gets the IMAP protocol string command for this command
    Returns the enum constant of this type with the specified name.
    static IMAPCommand[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

  • Method Details

    • values

      public static IMAPCommand[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static IMAPCommand valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getCommand

      public static final String getCommand(IMAPCommand command)
      Gets the IMAP protocol string command corresponding to a command code.
      Parameters:
      command - the IMAPCommand whose command string is required. Must not be null.
      Returns:
      The IMAP protocol string command corresponding to a command code.
    • getIMAPCommand

      Gets the IMAP protocol string command for this command
      Returns:
      The IMAP protocol string command corresponding to this command