Cloud Mail 2020 Node.js Edition

Questions / Feedback?

WebServerSSLEnabled Property

Whether the web server requires SSL connections.

Syntax

 oauth.getWebServerSSLEnabled([callback])
 oauth.setWebServerSSLEnabled( webServerSSLEnabled, [callback])

Default Value

FALSE

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 getWebServerSSLEnabled([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 setWebServerSSLEnabled([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 setting specifies whether the embedded web server use SSL. If set to True WebServerSSLCert is required and the server will only accept SSL connections. If set to False only plaintext connects are supported.

Data Type

Boolean

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]