AuthMechanism Property

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

Syntax

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

Possible Values

  0 (amUserPassword), 
  1 (amCRAMMD5), 
  2 (amNTLM), 
  4 (amSASLPlain), 
  5 (amSASLDigestMD5), 
  6 (amKerberos), 
  7 (amSASLXOAuth2)

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

By default, AuthMechanism is amUserPassword (0), and default plaintext authentication is used to login to the server.

If AuthMechanism is set to amSASLXOAuth2 (7), an OAUTH authorization string is used to authenticate. The Authorization property must be set to a valid authorization string.

At the time of this writing no other authentication mechanisms are supported by Google.

Data Type

Integer