imapflow 1.0.110 → 1.0.111

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+-   1.0.111 - 2022-10-13
+
+    -   Added new connection options
+        -   connectionTimeout=90000: how many milliseconds to wait for the connection to establish (default is 90 seconds)
+        -   greetingTimeout=16000: how many milliseconds to wait for the greeting after connection is established (default is 16 seconds)
+        -   socketTimeout=300000: how many milliseconds of inactivity to allow (default is 5 minutes)
+
 -   1.0.110 - 2022-10-10
 
     -   Allow unicode atoms by default

package/lib/imap-flow.js

@@ -132,6 +132,9 @@ class ImapFlow extends EventEmitter {
      * @param {Number} [options.maxIdleTime] If set, then breaks and restarts IDLE every maxIdleTime ms
      * @param {Boolean} [options.disableBinary=false] If true, then ignores the BINARY extension when making FETCH and APPEND calls
      * @param {Boolean} [options.disableAutoEnable] Do not enable supported extensions by default
+     * @param {Number} [options.connectionTimeout=90000] how many milliseconds to wait for the connection to establish (default is 90 seconds)
+     * @param {Number} [options.greetingTimeout=16000] how many milliseconds to wait for the greeting after connection is established (default is 16 seconds)
+     * @param {Number} [options.socketTimeout=300000] how many milliseconds of inactivity to allow (default is 5 minutes)
      */
     constructor(options) {
         super({ captureRejections: true });
@@ -1187,23 +1190,29 @@ class ImapFlow extends EventEmitter {
             this.connectTimeout = setTimeout(() => {
                 let err = new Error('Failed to established connection in required time');
                 err.code = 'CONNECT_TIMEOUT';
+                err.details = {
+                    connectionTimeout: this.options.connectionTimeout || CONNECT_TIMEOUT
+                };
                 this.log.error({ err, cid: this.id });
                 setImmediate(() => this.close());
                 reject(err);
-            }, CONNECT_TIMEOUT);
+            }, this.options.connectionTimeout || CONNECT_TIMEOUT);
 
             let onConnect = () => {
                 clearTimeout(this.connectTimeout);
                 this.socket.setKeepAlive(true, 5 * 1000);
-                this.socket.setTimeout(SOCKET_TIMEOUT);
+                this.socket.setTimeout(this.options.socketTimeout || SOCKET_TIMEOUT);
 
                 this.greetingTimeout = setTimeout(() => {
                     let err = new Error(`Failed to receive greeting from server in required time${!this.secureConnection ? '. Maybe should use TLS?' : ''}`);
                     err.code = 'GREEETING_TIMEOUT';
+                    err.details = {
+                        greetingTimeout: this.options.greetingTimeout || GREETING_TIMEOUT
+                    };
                     this.log.error({ err, cid: this.id });
                     setImmediate(() => this.close());
                     reject(err);
-                }, GREETING_TIMEOUT);
+                }, this.options.greetingTimeout || GREETING_TIMEOUT);
 
                 this.tls = typeof this.socket.getCipher === 'function' ? this.socket.getCipher() : false;
 

package/lib/types.d.ts

@@ -31,6 +31,9 @@ declare module "imapflow" {
      * @param [options.maxIdleTime] - If set, then breaks and restarts IDLE every maxIdleTime ms
      * @param [options.disableBinary = false] - If true, then ignores the BINARY extension when making FETCH and APPEND calls
      * @param [options.disableAutoEnable] - Do not enable supported extensions by default
+     * @param [options.connectionTimeout = 90000] - how many milliseconds to wait for the connection to establish (default is 90 seconds)
+     * @param [options.greetingTimeout = 16000] - how many milliseconds to wait for the greeting after connection is established (default is 16 seconds)
+     * @param [options.socketTimeout = 300000] - how many milliseconds of inactivity to allow (default is 5 minutes)
      */
     class ImapFlow extends EventEmitter {
         constructor(options: {
@@ -60,6 +63,9 @@ declare module "imapflow" {
             maxIdleTime?: number;
             disableBinary?: boolean;
             disableAutoEnable?: boolean;
+            connectionTimeout?: number;
+            greetingTimeout?: number;
+            socketTimeout?: number;
         });
         /**
          * Current module version as a static class property

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.110",
+    "version": "1.0.111",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -30,8 +30,8 @@
         "@babel/eslint-parser": "7.19.1",
         "@babel/eslint-plugin": "7.19.1",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.19.3",
-        "@types/node": "18.8.3",
+        "@babel/preset-env": "7.19.4",
+        "@types/node": "18.8.5",
         "braintree-jsdoc-template": "3.3.0",
         "eslint": "8.25.0",
         "eslint-config-nodemailer": "1.2.0",