imapflow 1.2.5 → 1.2.6

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-    ".": "1.2.5"
+    ".": "1.2.6"
 }

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.2.6](https://github.com/postalsys/imapflow/compare/v1.2.5...v1.2.6) (2026-01-12)
+
+
+### Bug Fixes
+
+* prevent memory leaks in socket and event handling ([2dfa6f3](https://github.com/postalsys/imapflow/commit/2dfa6f3d77ccdf31244752d669ab694f1c157b4c))
+* restore isClosed check and error logging in initialPREAUTH ([ae2ebcf](https://github.com/postalsys/imapflow/commit/ae2ebcff5a65aa870b1af70726f7c5c6ac54395e))
+
 ## [1.2.5](https://github.com/postalsys/imapflow/compare/v1.2.4...v1.2.5) (2026-01-11)
 
 

package/lib/commands/append.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { getStatusCode, formatFlag, canUseFlag, formatDateTime, normalizePath, encodePath, comparePaths, getErrorText } = require('../tools.js');
+const { formatFlag, canUseFlag, formatDateTime, normalizePath, encodePath, comparePaths, enhanceCommandError } = require('../tools.js');
 
 // Appends a message to a mailbox
 module.exports = async (connection, destination, content, flags, idate) => {
@@ -139,12 +139,7 @@ module.exports = async (connection, destination, content, flags, idate) => {
 
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         throw err;
     }

package/lib/commands/copy.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { getStatusCode, normalizePath, encodePath, expandRange, getErrorText } = require('../tools.js');
+const { normalizePath, encodePath, expandRange, enhanceCommandError } = require('../tools.js');
 
 // Copies messages from current mailbox to some other mailbox
 module.exports = async (connection, range, destination, options) => {
@@ -44,12 +44,7 @@ module.exports = async (connection, range, destination, options) => {
 
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/create.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, normalizePath, getStatusCode, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, getStatusCode, enhanceCommandError } = require('../tools.js');
 
 // Creates a new mailbox
 module.exports = async (connection, path) => {
@@ -61,24 +61,15 @@ module.exports = async (connection, path) => {
         return map;
     } catch (err) {
         let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
-        switch (errorCode) {
-            case 'ALREADYEXISTS':
-                // no need to do anything, mailbox already exists
-                return {
-                    path,
-                    created: false
-                };
-        }
-
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
+        if (errorCode === 'ALREADYEXISTS') {
+            // no need to do anything, mailbox already exists
+            return {
+                path,
+                created: false
+            };
         }
 
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         throw err;
     }

package/lib/commands/delete.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, normalizePath, getStatusCode, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, enhanceCommandError } = require('../tools.js');
 
 // Deletes an existing mailbox
 module.exports = async (connection, path) => {
@@ -24,12 +24,7 @@ module.exports = async (connection, path) => {
         response.next();
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         throw err;
     }

package/lib/commands/expunge.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { getStatusCode, getErrorText } = require('../tools.js');
+const { enhanceCommandError } = require('../tools.js');
 
 // Deletes specified messages
 module.exports = async (connection, range, options) => {
@@ -34,12 +34,7 @@ module.exports = async (connection, range, options) => {
         response.next();
         return true;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/move.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { getStatusCode, normalizePath, encodePath, expandRange, getErrorText } = require('../tools.js');
+const { normalizePath, encodePath, expandRange, enhanceCommandError } = require('../tools.js');
 
 // Moves messages from current mailbox to some other mailbox
 module.exports = async (connection, range, destination, options) => {
@@ -60,12 +60,7 @@ module.exports = async (connection, range, destination, options) => {
         checkMoveInfo(response.response);
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/quota.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, getStatusCode, normalizePath, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, enhanceCommandError } = require('../tools.js');
 
 // Requests quota information for a mailbox
 module.exports = async (connection, path) => {
@@ -95,12 +95,7 @@ module.exports = async (connection, path) => {
 
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/rename.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, normalizePath, getStatusCode, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, enhanceCommandError } = require('../tools.js');
 
 // Renames existing mailbox
 module.exports = async (connection, path, newPath) => {
@@ -29,12 +29,7 @@ module.exports = async (connection, path, newPath) => {
         response.next();
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         throw err;
     }

package/lib/commands/search.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { getStatusCode, getErrorText } = require('../tools.js');
+const { enhanceCommandError } = require('../tools.js');
 const { searchCompiler } = require('../search-compiler.js');
 
 // Updates flags for a message
@@ -43,12 +43,7 @@ module.exports = async (connection, query, options) => {
         response.next();
         return Array.from(results).sort((a, b) => a - b);
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/select.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, normalizePath, getStatusCode, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, enhanceCommandError } = require('../tools.js');
 
 // Selects a mailbox
 module.exports = async (connection, path, options) => {
@@ -194,11 +194,7 @@ module.exports = async (connection, path, options) => {
         response.next();
         return map;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
+        await enhanceCommandError(err);
 
         if (connection.state === connection.states.SELECTED) {
             // reset selected state

package/lib/commands/store.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { getStatusCode, formatFlag, canUseFlag, getErrorText } = require('../tools.js');
+const { formatFlag, canUseFlag, enhanceCommandError } = require('../tools.js');
 
 // Updates flags for a message
 module.exports = async (connection, range, flags, options) => {
@@ -72,12 +72,7 @@ module.exports = async (connection, range, flags, options) => {
         response.next();
         return true;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/subscribe.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, normalizePath, getStatusCode, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, enhanceCommandError } = require('../tools.js');
 
 // Subscribes to a mailbox
 module.exports = async (connection, path) => {
@@ -17,12 +17,7 @@ module.exports = async (connection, path) => {
         response.next();
         return true;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/commands/unsubscribe.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { encodePath, normalizePath, getStatusCode, getErrorText } = require('../tools.js');
+const { encodePath, normalizePath, enhanceCommandError } = require('../tools.js');
 
 // Unsubscribes from a mailbox
 module.exports = async (connection, path) => {
@@ -17,13 +17,7 @@ module.exports = async (connection, path) => {
         response.next();
         return true;
     } catch (err) {
-        let errorCode = getStatusCode(err.response);
-        if (errorCode) {
-            err.serverResponseCode = errorCode;
-        }
-
-        err.response = await getErrorText(err.response);
-
+        await enhanceCommandError(err);
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/imap-flow.js

@@ -372,7 +372,8 @@ class ImapFlow extends EventEmitter {
 
         this.disableBinary = !!this.options.disableBinary;
 
-        this.streamer.on('error', err => {
+        // Named error handler for proper cleanup
+        this._streamerErrorHandler = err => {
             if (['Z_BUF_ERROR', 'ECONNRESET', 'EPIPE', 'ETIMEDOUT', 'EHOSTUNREACH'].includes(err.code)) {
                 // just close the connection, usually nothing but noise
                 this.closeAfter();
@@ -381,7 +382,8 @@ class ImapFlow extends EventEmitter {
 
             this.log.error({ err, cid: this.id });
             this.emitError(err);
-        });
+        };
+        this.streamer.on('error', this._streamerErrorHandler);
 
         // Has the `connect` method already been called
         this._connectCalled = false;
@@ -772,6 +774,12 @@ class ImapFlow extends EventEmitter {
         // Clear any existing handlers first to prevent duplicates
         this.clearSocketHandlers();
 
+        // Remove temporary connection error handler if present
+        if (this._connectErrorHandler && this.socket) {
+            this.socket.removeListener('error', this._connectErrorHandler);
+            this._connectErrorHandler = null;
+        }
+
         this._socketError =
             this._socketError ||
             (err => {
@@ -828,6 +836,12 @@ class ImapFlow extends EventEmitter {
             return;
         }
 
+        // Remove temporary connection error handler if still present
+        if (this._connectErrorHandler) {
+            this.socket.removeListener('error', this._connectErrorHandler);
+            this._connectErrorHandler = null;
+        }
+
         if (this._socketError) {
             this.socket.removeListener('error', this._socketError);
             this.socket.removeListener('tlsClientError', this._socketError);
@@ -1043,7 +1057,8 @@ class ImapFlow extends EventEmitter {
             );
             this.clearSocketHandlers();
 
-            socketPlain.once('error', err => {
+            // Store error handler for cleanup after successful upgrade
+            const socketPlainErrorHandler = err => {
                 clearTimeout(this.connectTimeout);
                 clearTimeout(this.upgradeTimeout);
                 if (!this.upgrading) {
@@ -1054,7 +1069,8 @@ class ImapFlow extends EventEmitter {
                 this.upgrading = false;
                 err.tlsFailed = true;
                 reject(err);
-            });
+            };
+            socketPlain.once('error', socketPlainErrorHandler);
 
             this.upgradeTimeout = setTimeout(() => {
                 if (!this.upgrading) {
@@ -1093,6 +1109,9 @@ class ImapFlow extends EventEmitter {
                         });
                     }
 
+                    // Clean up the plain socket error handler after successful upgrade
+                    socketPlain.removeListener('error', socketPlainErrorHandler);
+
                     return resolve(true);
                 } catch (ex) {
                     this.emitError(ex);
@@ -1175,13 +1194,7 @@ class ImapFlow extends EventEmitter {
         throw new AuthenticationFailure('No matching authentication method');
     }
 
-    async initialOK(message) {
-        this.greeting = (message.attributes || [])
-            .filter(entry => entry.type === 'TEXT')
-            .map(entry => entry.value)
-            .filter(entry => entry)
-            .join('');
-
+    beginSession(onUnhandledError) {
         clearTimeout(this.greetingTimeout);
         this.untaggedHandlers.OK = null;
         this.untaggedHandlers.PREAUTH = null;
@@ -1211,45 +1224,30 @@ class ImapFlow extends EventEmitter {
                     return reject(err);
                 }
 
-                // ALWAYS emit the error so users can handle it
-                this.emitError(err);
+                onUnhandledError(err);
             });
     }
 
-    async initialPREAUTH() {
-        clearTimeout(this.greetingTimeout);
-        this.untaggedHandlers.OK = null;
-        this.untaggedHandlers.PREAUTH = null;
+    async initialOK(message) {
+        this.greeting = (message.attributes || [])
+            .filter(entry => entry.type === 'TEXT')
+            .map(entry => entry.value)
+            .filter(entry => entry)
+            .join('');
 
+        // ALWAYS emit the error so users can handle it
+        this.beginSession(err => this.emitError(err));
+    }
+
+    async initialPREAUTH() {
         if (this.isClosed) {
             return;
         }
-
         this.state = this.states.AUTHENTICATED;
-
-        // get out of current parsing "thread", so do not await for startSession
-        this.startSession()
-            .then(() => {
-                if (typeof this.initialResolve === 'function') {
-                    let resolve = this.initialResolve;
-                    this.initialResolve = false;
-                    this.initialReject = false;
-                    return resolve();
-                }
-            })
-            .catch(err => {
-                this.log.error({ err, cid: this.id });
-
-                if (typeof this.initialReject === 'function') {
-                    clearTimeout(this.greetingTimeout);
-                    let reject = this.initialReject;
-                    this.initialResolve = false;
-                    this.initialReject = false;
-                    return reject(err);
-                }
-
-                this.closeAfter();
-            });
+        this.beginSession(err => {
+            this.log.error({ err, cid: this.id });
+            this.closeAfter();
+        });
     }
 
     async serverBye(parsed) {
@@ -1267,9 +1265,9 @@ class ImapFlow extends EventEmitter {
         this.state = this.states.LOGOUT;
     }
 
-    async sectionCapability(section) {
-        this.rawCapabilities = section;
-        this.capabilities = updateCapabilities(section);
+    updateCapabilitiesFromRaw(rawCapabilities) {
+        this.rawCapabilities = rawCapabilities;
+        this.capabilities = updateCapabilities(rawCapabilities);
 
         if (this.capabilities) {
             for (let [capa] of this.capabilities) {
@@ -1284,21 +1282,12 @@ class ImapFlow extends EventEmitter {
         }
     }
 
-    async untaggedCapability(untagged) {
-        this.rawCapabilities = untagged.attributes;
-        this.capabilities = updateCapabilities(untagged.attributes);
-
-        if (this.capabilities) {
-            for (let [capa] of this.capabilities) {
-                if (/^AUTH=/i.test(capa) && !this.authCapabilities.has(capa.toUpperCase())) {
-                    this.authCapabilities.set(capa.toUpperCase(), false);
-                }
-            }
-        }
+    async sectionCapability(section) {
+        this.updateCapabilitiesFromRaw(section);
+    }
 
-        if (this.expectCapabilityUpdate) {
-            this.expectCapabilityUpdate = false;
-        }
+    async untaggedCapability(untagged) {
+        this.updateCapabilitiesFromRaw(untagged.attributes);
     }
 
     async untaggedExists(untagged) {
@@ -1637,13 +1626,15 @@ class ImapFlow extends EventEmitter {
 
             this.writeSocket = this.socket;
 
-            this.socket.on('error', err => {
+            // Store connection error handler for cleanup
+            this._connectErrorHandler = err => {
                 clearTimeout(this.connectTimeout);
                 clearTimeout(this.greetingTimeout);
                 this.closeAfter();
                 this.log.error({ err, cid: this.id });
                 reject(err);
-            });
+            };
+            this.socket.on('error', this._connectErrorHandler);
         });
     }
 
@@ -1791,11 +1782,13 @@ class ImapFlow extends EventEmitter {
             // cleanup streamer
             if (this.streamer) {
                 try {
-                    // remove our listeners
+                    // remove our listeners explicitly by reference
                     if (this.socketReadable) {
                         this.streamer.removeListener('readable', this.socketReadable);
                     }
-                    this.streamer.removeAllListeners('error');
+                    if (this._streamerErrorHandler) {
+                        this.streamer.removeListener('error', this._streamerErrorHandler);
+                    }
                     if (!this.streamer.destroyed) {
                         this.streamer.destroy();
                     }
@@ -1841,6 +1834,18 @@ class ImapFlow extends EventEmitter {
                 }
             }
 
+            // Explicit nullification to help garbage collection
+            this.socket = null;
+            this.writeSocket = null;
+            this._inflate = null;
+            this._deflate = null;
+            this._streamerErrorHandler = null;
+            this._connectErrorHandler = null;
+            this._socketError = null;
+            this._socketClose = null;
+            this._socketEnd = null;
+            this._socketTimeout = null;
+
             this.log.trace({ msg: 'Connection closed', cid: this.id });
             this.emit('close');
         } catch (ex) {

package/lib/tools.js

@@ -115,6 +115,15 @@ const tools = {
         return (await compiler(response)).toString();
     },
 
+    async enhanceCommandError(err) {
+        let errorCode = tools.getStatusCode(err.response);
+        if (errorCode) {
+            err.serverResponseCode = errorCode;
+        }
+        err.response = await tools.getErrorText(err.response);
+        return err;
+    },
+
     getFolderTree(folders) {
         let tree = {
             root: true,
@@ -758,38 +767,40 @@ const tools = {
         return Object.prototype.toString.call(obj) === '[object Date]';
     },
 
-    formatDate(value) {
+    toValidDate(value) {
+        if (!value) {
+            return null;
+        }
         if (typeof value === 'string') {
             value = new Date(value);
         }
+        if (!tools.isDate(value) || value.toString() === 'Invalid Date') {
+            return null;
+        }
+        return value;
+    },
 
-        if (Object.prototype.toString(value) !== '[object Object]' || value.toString() === 'Invalid Date') {
+    formatDate(value) {
+        value = tools.toValidDate(value);
+        if (!value) {
             return;
         }
 
-        value = value.toISOString().substr(0, 10);
-        value = value.split('-');
-        value.reverse();
+        let dateParts = value.toISOString().substr(0, 10).split('-');
+        dateParts.reverse();
 
         let months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
-        value[1] = months[Number(value[1]) - 1];
+        dateParts[1] = months[Number(dateParts[1]) - 1];
 
-        return value.join('-');
+        return dateParts.join('-');
     },
 
     formatDateTime(value) {
+        value = tools.toValidDate(value);
         if (!value) {
             return;
         }
 
-        if (typeof value === 'string') {
-            value = new Date(value);
-        }
-
-        if (Object.prototype.toString(value) !== '[object Object]' || value.toString() === 'Invalid Date') {
-            return;
-        }
-
         let dateStr = tools.formatDate(value).replace(/^0/, ' '); //starts with date-day-fixed with leading 0 replaced by SP
         let timeStr = value.toISOString().substr(11, 8);
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.2.5",
+    "version": "1.2.6",
     "description": "IMAP Client for Node",
     "main": "lib/imap-flow.js",
     "types": "lib/imap-flow.d.ts",