Cloud Mail 2020 Node.js Edition

Questions / Feedback?

ConnectionStatus Event

Fired to indicate changes in connection state.

Syntax

oauth.on('ConnectionStatus', [callback])

Callback

The 'callback' is called when the 'ConnectionStatus' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.connectionEvent
e.statusCode
e.description

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

The ConnectionEvent parameter indicates the type of connection event. Values may include:

Firewall connection complete.
SSL or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

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