imapflow 1.0.146 → 1.0.148

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.0.148](https://github.com/postalsys/imapflow/compare/v1.0.147...v1.0.148) (2024-01-16)
+
+
+### Bug Fixes
+
+* **logout:** Fixed race condition for logout and TCP close. Fixes [#161](https://github.com/postalsys/imapflow/issues/161) ([39a7333](https://github.com/postalsys/imapflow/commit/39a7333a39499e4876abb29149f7c72f2f99a63d))
+
+## [1.0.147](https://github.com/postalsys/imapflow/compare/v1.0.146...v1.0.147) (2023-10-26)
+
+
+### Bug Fixes
+
+* **idle:** removed unneeded variable ([da59d9a](https://github.com/postalsys/imapflow/commit/da59d9a960dd0992b22335902808a315b1cb6ded))
+
 ## [1.0.146](https://github.com/postalsys/imapflow/compare/v1.0.145...v1.0.146) (2023-10-26)
 
 

package/jsdoc.json

@@ -23,6 +23,6 @@
         "encoding": "utf8",
         "private": true,
         "recurse": true,
-        "template": "./node_modules/braintree-jsdoc-template"
+        "template": "./node_modules/imapflow-jsdoc-template"
     }
 }

package/lib/commands/idle.js

@@ -110,8 +110,6 @@ module.exports = async (connection, maxIdleTime) => {
         return;
     }
 
-    maxIdleTime = 3000;
-
     if (connection.capabilities.has('IDLE')) {
         let idleTimer;
         let stillIdling = false;

package/lib/commands/logout.js

@@ -18,6 +18,9 @@ module.exports = async connection => {
         response = await connection.exec('LOGOUT');
         return true;
     } catch (err) {
+        if (err.code === 'NoConnection') {
+            return true;
+        }
         connection.log.warn({ err, cid: connection.id });
         return false;
     } finally {

package/lib/imap-flow.js

@@ -371,7 +371,9 @@ class ImapFlow extends EventEmitter {
                 let request = this.requestTagMap.get(data.tag);
                 if (request) {
                     this.requestTagMap.delete(request.tag);
-                    request.reject(new Error('Connection not available'));
+                    const error = new Error('Connection not available');
+                    error.code = 'NoConnection';
+                    request.reject(error);
                 }
             }
             return;
@@ -595,6 +597,7 @@ class ImapFlow extends EventEmitter {
 
                     default: {
                         let err = new Error('Invalid server response');
+                        err.code = 'InvalidResponse';
                         err.response = parsed;
                         request.reject(err);
                         break;
@@ -1393,7 +1396,7 @@ class ImapFlow extends EventEmitter {
      * await client.logout();
      */
     async logout() {
-        await this.run('LOGOUT');
+        return await this.run('LOGOUT');
     }
 
     /**
@@ -1432,9 +1435,11 @@ class ImapFlow extends EventEmitter {
         // reject command that is currently processed
         if (this.currentRequest && this.requestTagMap.has(this.currentRequest.tag)) {
             let request = this.requestTagMap.get(this.currentRequest.tag);
-            if (request) {
+            if (request && ['LOGOUT'].includes(request.command)) {
                 this.requestTagMap.delete(request.tag);
-                request.reject(new Error('Connection not available'));
+                const error = new Error('Connection not available');
+                error.code = 'NoConnection';
+                request.reject(error);
             }
             this.currentRequest = false;
         }
@@ -1446,7 +1451,9 @@ class ImapFlow extends EventEmitter {
                 let request = this.requestTagMap.get(req.tag);
                 if (request) {
                     this.requestTagMap.delete(request.tag);
-                    request.reject(new Error('Connection not available'));
+                    const error = new Error('Connection not available');
+                    error.code = 'NoConnection';
+                    request.reject(error);
                 }
             }
         }
@@ -2602,7 +2609,7 @@ class ImapFlow extends EventEmitter {
      * @example
      * let mailbox = await client.mailboxOpen('INBOX');
      * // download body parts '2', and '3' from all messages in the selected mailbox
-     * let response = await client.downloadMany('*', ['2', '3]);
+     * let response = await client.downloadMany('*', ['2', '3']);
      * process.stdout.write(response[2].content)
      * process.stdout.write(response[3].content)
      */
@@ -2728,8 +2735,9 @@ class ImapFlow extends EventEmitter {
         }
 
         if (this.socket.destroyed) {
-            let err = new Error('Connection not available');
-            throw err;
+            const error = new Error('Connection not available');
+            error.code = 'NoConnection';
+            throw error;
         }
 
         clearTimeout(this.idleStartTimer);
@@ -2771,10 +2779,11 @@ class ImapFlow extends EventEmitter {
         const { resolve, reject, path, options, lockId } = this.locks.shift();
 
         if (!this.usable || this.socket.destroyed) {
-            // reject all
-            let err = new Error('Connection not available');
             this.log.trace({ msg: 'Failed to acquire mailbox lock', path, lockId });
-            reject(err);
+            // reject all
+            let error = new Error('Connection not available');
+            error.code = 'NoConnection';
+            reject(error);
             return await this.processLocks(true);
         }
 

package/lib/types.d.ts

@@ -502,7 +502,7 @@ declare module "imapflow" {
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
          * // download body parts '2', and '3' from all messages in the selected mailbox
-         * let response = await client.downloadMany('*', ['2', '3]);
+         * let response = await client.downloadMany('*', ['2', '3']);
          * process.stdout.write(response[2].content)
          * process.stdout.write(response[3].content)
          * @param range - UID or sequence number for the message to fetch

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.146",
+    "version": "1.0.148",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -32,8 +32,7 @@
         "@babel/eslint-plugin": "7.22.10",
         "@babel/plugin-syntax-class-properties": "7.12.13",
         "@babel/preset-env": "7.23.2",
-        "@types/node": "20.8.9",
-        "braintree-jsdoc-template": "3.3.0",
+        "@types/node": "20.8.10",
         "eslint": "8.52.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.0.0",
@@ -41,6 +40,7 @@
         "grunt-cli": "1.4.3",
         "grunt-contrib-nodeunit": "5.0.0",
         "grunt-eslint": "24.3.0",
+        "imapflow-jsdoc-template": "3.4.0-imapflow.1",
         "jsdoc": "3.6.11",
         "st": "3.0.0",
         "tsd-jsdoc": "2.5.0"