AuthMechanism Property

Used when connecting to the mail server.

Syntax

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

Possible Values

  0 (amUserPassword), 
  1 (amCRAMMD5), 
  2 (amNTLM), 
  3 (amAPOP), 
  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

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

By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

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

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

When set to amXOAUTH2 (7) set User to the username and AuthorizationIdentity to the OAuth token. See AuthorizationIdentity for details.

Data Type

Integer