org.apache.commons.net.imap
Enum AuthenticatingIMAPClient.AUTH_METHOD

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

public static enum AuthenticatingIMAPClient.AUTH_METHOD
extends Enum<AuthenticatingIMAPClient.AUTH_METHOD>

The enumeration of currently-supported authentication methods.


Enum Constant Summary
CRAM_MD5
          The standarised (RFC2195) CRAM-MD5 method, which doesn't send the password (secure).
LOGIN
          The unstandarised Microsoft LOGIN method, which sends the password unencrypted (insecure).
PLAIN
          The standarised (RFC4616) PLAIN method, which sends the password unencrypted (insecure).
XOAUTH
          XOAUTH
 
Method Summary
 String getAuthName()
          Gets the name of the given authentication method suitable for the server.
static AuthenticatingIMAPClient.AUTH_METHOD valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AuthenticatingIMAPClient.AUTH_METHOD[] values()
          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 Detail

PLAIN

public static final AuthenticatingIMAPClient.AUTH_METHOD PLAIN
The standarised (RFC4616) PLAIN method, which sends the password unencrypted (insecure).


CRAM_MD5

public static final AuthenticatingIMAPClient.AUTH_METHOD CRAM_MD5
The standarised (RFC2195) CRAM-MD5 method, which doesn't send the password (secure).


LOGIN

public static final AuthenticatingIMAPClient.AUTH_METHOD LOGIN
The unstandarised Microsoft LOGIN method, which sends the password unencrypted (insecure).


XOAUTH

public static final AuthenticatingIMAPClient.AUTH_METHOD XOAUTH
XOAUTH

Method Detail

values

public static AuthenticatingIMAPClient.AUTH_METHOD[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AuthenticatingIMAPClient.AUTH_METHOD c : AuthenticatingIMAPClient.AUTH_METHOD.values())
    System.out.println(c);

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.


Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.