FirewallType Property

This property determines the type of firewall to connect through.

Syntax

 pimap.getFirewallType([callback])
 pimap.setFirewallType( firewallType, [callback])

Possible Values

  0 (fwNone), 
  1 (fwTunnel), 
  2 (fwSOCKS4), 
  3 (fwSOCKS5), 
  10 (fwSOCKS4A)

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 getFirewallType([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 setFirewallType([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 determines the type of firewall to connect through. The applicable values are the following:

Data Type

Integer