IP*Works! OpenPGP V9 - Online Help
IP*Works! OpenPGP V9
Questions / Feedback?

AuthMechanism Property

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

Syntax

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

Possible Values

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

Default Value

0


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 amCRAMMD5 (1), the more secure CRAM-MD5 authentication is used instead.

If AuthMechanism is set to amNTLM (2) NTLM authentication will be used.

AuthMechanism can be set to amSASLPlain (4) as well. Note, however, that servers will often require SSL or some other encrypted session protection be used when this authentication mechanism is requested.

If AuthMechanism is set to amKerberos (6) Kerberos authentication will be used. NOTE: This functionality is only available in Windows.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0