AuthMechanism Property

The authentication mechanism to be used when connecting to the mail server.

Syntax

 ppop.getAuthMechanism([callback])
 ppop.setAuthMechanism( authMechanism, [callback])

Possible Values

  0 (amUserPassword), 
  1 (amCRAMMD5), 
  2 (amNTLM), 
  3 (amAPOP), 
  4 (amSASLPlain), 
  5 (amSASLDigestMD5), 
  6 (amKerberos)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAuthMechanism([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAuthMechanism([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to login to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.

amSASLPlain (4) is also available, but most servers require a secure SSL connection when utilizing this authentication mechanism.

amKerberos (6) is for Kerberos authentication. NOTE: This functionality is only available in Windows.

Data Type

Integer