Cloud Mail 2020 Node.js Edition

Questions / Feedback?

WebServerPort Property

The local port on which the embedded web server listens.

Syntax

 oauth.getWebServerPort([callback])
 oauth.setWebServerPort( webServerPort, [callback])

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 getWebServerPort([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 setWebServerPort([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 specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

Data Type

Integer

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