Enum AuthenticatingIMAPClient.AUTH_METHOD

java.lang.Object
java.lang.Enum<AuthenticatingIMAPClient.AUTH_METHOD>
org.apache.commons.net.imap.AuthenticatingIMAPClient.AUTH_METHOD
All Implemented Interfaces:
Serializable, Comparable<AuthenticatingIMAPClient.AUTH_METHOD>, java.lang.constant.Constable
Enclosing class:
AuthenticatingIMAPClient

public static enum AuthenticatingIMAPClient.AUTH_METHOD extends Enum<AuthenticatingIMAPClient.AUTH_METHOD>
The enumeration of currently-supported authentication methods.
  • Enum Constant Details

  • Field Details

    • authName

      private final String authName
  • Constructor Details

    • AUTH_METHOD

      private AUTH_METHOD(String name)
  • Method Details

    • values

      public static AuthenticatingIMAPClient.AUTH_METHOD[] 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 AuthenticatingIMAPClient.AUTH_METHOD 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
    • getAuthName

      public final String getAuthName()
      Gets the name of the given authentication method suitable for the server.
      Returns:
      The name of the given authentication method suitable for the server.