imapflow 2.0.8 → 2.1.0

package/dist/esm/imap-flow.js

@@ -17,7 +17,7 @@ import { downloadMessage, downloadMessageParts } from './download.js';
 import { AuthenticationFailure } from './errors.js';
 import imapCommands from './imap-commands.js';
 import { comparePaths, updateCapabilities, getFolderTree, formatMessageResponse, packMessageRange, normalizePath, expandRange, getColorFlags, hasCapability, isRev2Active, logConnectionError, unrefTimer, clearTimer, parseUintValue, getStringList, getTextValues, emitSafe, buildConnectionError, guardedPromise, guardedReject, MAX_UINT32_DIGITS } from './tools.js';
-export { AuthenticationFailure } from './errors.js';
+export { AuthenticationFailure, ImapFlowErrorCode } from './errors.js';
 const GREETING_TIMEOUT = 16 * 1000;
 const UPGRADE_TIMEOUT = 10 * 1000;
 const SOCKET_TIMEOUT = 5 * 60 * 1000;
@@ -1561,6 +1561,7 @@ export class ImapFlow extends EventEmitter {
     /** @internal */
     beginSession(onUnhandledError) {
         clearTimer(this.greetingTimeout);
+        this.greetingReceived = true;
         this.untaggedHandlers.OK = null;
         this.untaggedHandlers.PREAUTH = null;
         if (this.isClosed) {
@@ -1620,6 +1621,12 @@ export class ImapFlow extends EventEmitter {
         this.byeReason = reason || 'Server closed connection';
         this.untaggedHandlers.BYE = null;
         this.state = this.states.LOGOUT;
+        // A BYE greeting rejects the connection outright. Do not wait for the server to close
+        // the socket: one that keeps it open would leave connect() pending until the greeting
+        // timeout.
+        if (!this.greetingReceived) {
+            this.closeAfter();
+        }
     }
     // Drops every capability-derived field together - the counterpart of
     // updateCapabilitiesFromRaw() below, which sets them together. rawCapabilities is
@@ -1852,7 +1859,7 @@ export class ImapFlow extends EventEmitter {
     /** @internal */
     autoidle() {
         clearTimer(this.idleStartTimer);
-        if (this.options.disableAutoIdle || this.state !== this.states.SELECTED) {
+        if (this.options.disableAutoIdle || !this.usable || this.state !== this.states.SELECTED) {
             return;
         }
         if (this.connectionBusy()) {
@@ -1864,7 +1871,7 @@ export class ImapFlow extends EventEmitter {
             // missed clearTimeout would inject IDLE between a caller's own commands. Declining
             // postpones rather than cancels: whatever made the connection busy calls autoidle()
             // again when it finishes.
-            if (this.state !== this.states.SELECTED || this.connectionBusy()) {
+            if (!this.usable || this.state !== this.states.SELECTED || this.connectionBusy()) {
                 return;
             }
             this.idle().catch(err => logConnectionError(this, 'Auto-IDLE failed', err));
@@ -3349,7 +3356,8 @@ export class ImapFlow extends EventEmitter {
     }
     /**
      * Detaches sockets from the IMAP pipeline. Useful for upgrading the connection
-     * (e.g., STARTTLS) or transferring socket ownership.
+     * (e.g., STARTTLS) or transferring socket ownership. Call it while the connection is not
+     * idling: an IDLE in progress is not broken first, so the server still expects `DONE`.
      *
      * @returns Socket objects: `readSocket` is the read socket (inflated socket if compression is enabled, raw socket otherwise),
      *   `writeSocket` the write socket and `socket` the raw underlying socket (same as readSocket/writeSocket when compression is disabled)
@@ -3364,6 +3372,11 @@ export class ImapFlow extends EventEmitter {
         // compression is active, the PassThrough writeSocket - so the connection
         // is fully released to the caller.
         this.clearSocketHandlers();
+        // The socket now belongs to the caller. Marking the client unusable keeps
+        // auto-IDLE (armed now, or re-armed by a lock release or a finished download)
+        // and a later dispose from writing IDLE or LOGOUT onto it.
+        this.usable = false;
+        clearTimer(this.idleStartTimer);
         const readSocket = this._inflate || socket;
         const writeSocket = this.writeSocket || socket;
         // Defense-in-depth: when compression is active the raw socket is orphaned
@@ -3461,6 +3474,23 @@ export class ImapFlow extends EventEmitter {
  *     console.log(`${entry.cid} ${entry.msg}`);
  * });
  */
+// Installed outside the class body: a computed `[Symbol.asyncDispose]` key would turn into a
+// method named "undefined" on Node.js 20.0-20.3, which predate the symbol
+if (typeof Symbol.asyncDispose === 'symbol') {
+    ImapFlow.prototype[Symbol.asyncDispose] = async function () {
+        if (this.usable) {
+            try {
+                await this.logout();
+            }
+            catch (err) {
+                logConnectionError(this, 'LOGOUT failed while disposing', err);
+            }
+        }
+        // logout() already closes the connection; close() is idempotent and covers a client
+        // that never connected or whose logout was skipped
+        this.close();
+    };
+}
 // Both `import { ImapFlow } from 'imapflow'` and `import imapflow from 'imapflow'` work, the
 // latter matching the shape `require('imapflow')` has always had
 const imapflow = { ImapFlow, AuthenticationFailure };

package/dist/esm/package-info.d.ts

@@ -1,3 +1,3 @@
 export declare const name = "imapflow";
-export declare const version = "2.0.8";
+export declare const version = "2.1.0";
 export declare const homepage = "https://imapflow.com/";

package/dist/esm/package-info.js

@@ -1,4 +1,4 @@
 // Generated by scripts/build.js from package.json. Do not edit by hand.
 export const name = "imapflow";
-export const version = "2.0.8";
+export const version = "2.1.0";
 export const homepage = "https://imapflow.com/";

package/dist/esm/tools.d.ts

@@ -1,6 +1,6 @@
 import type { Transform } from 'node:stream';
 import type { ImapFlow } from './imap-flow.js';
-import type { ConnectionErrorSite, ImapFlowError } from './errors.js';
+import { type ConnectionErrorSite, type ImapFlowError } from './errors.js';
 import type { ImapAttributeList, ImapAttributeNode, ImapResponse } from './handler/types.js';
 import type { FetchMessageObject, ListResponse, ListTreeResponse, MailboxObject, MessageEnvelopeObject, MessageStructureObject, ImapFlowEvents, StatusQuery } from './types.js';
 export { AuthenticationFailure } from './errors.js';

package/dist/esm/tools.js

@@ -5,10 +5,11 @@ import { compiler } from './handler/imap-handler.js';
 import { createHash } from 'node:crypto';
 import { JPDecoder } from './jp-decoder.js';
 import iconv from 'iconv-lite';
+import { ImapFlowErrorCode } from './errors.js';
 export { AuthenticationFailure } from './errors.js';
 const FLAG_COLORS = ['red', 'orange', 'yellow', 'green', 'blue', 'purple', 'grey'];
 // Error codes that only mean the connection is no longer usable. See logConnectionError().
-const CONNECTION_GONE_CODES = new Set(['NoConnection', 'EConnectionClosed', 'StateLogout']);
+const CONNECTION_GONE_CODES = new Set([ImapFlowErrorCode.NoConnection, ImapFlowErrorCode.EConnectionClosed, ImapFlowErrorCode.StateLogout]);
 // Upper bound for expanding server-supplied sequence ranges (see expandRange). 2^24
 // entries in total is far beyond any legitimate mailbox while keeping the worst-case
 // expansion of a hostile range set bounded.
@@ -1092,7 +1093,7 @@ export function parseBodystructure(entry) {
             curNode.type = 'multipart/' + ((node[i++] || {}).value || '').toString().toLowerCase();
             // extension data (not available for BODY requests)
             // body parameter parenthesized list
-            if (i < node.length - 1) {
+            if (i < node.length) {
                 if (node[i]) {
                     curNode.parameters = getStructuredParams(node[i]);
                 }
@@ -1174,7 +1175,7 @@ export function parseBodystructure(entry) {
             }
             // extension data (not available for BODY requests)
             // md5
-            if (i < node.length - 1) {
+            if (i < node.length) {
                 if (node[i]) {
                     curNode.md5 = (node[i].value || '').toString().toLowerCase();
                 }
@@ -1184,7 +1185,7 @@ export function parseBodystructure(entry) {
         // the following are shared extension values (for both multipart and non-multipart parts)
         // not available for BODY requests
         // body disposition
-        if (i < node.length - 1) {
+        if (i < node.length) {
             let disposition = node[i];
             if (Array.isArray(disposition) && disposition.length) {
                 curNode.disposition = ((disposition[0] && disposition[0].value) || '').toString().toLowerCase();
@@ -1195,7 +1196,7 @@ export function parseBodystructure(entry) {
             i++;
         }
         // body language
-        if (i < node.length - 1) {
+        if (i < node.length) {
             if (node[i]) {
                 /* c8 ignore next */ // node[i] is truthy inside this guard, so the [] fallback is unreachable
                 curNode.language = [].concat(node[i] || []).map(val => ((val && val.value) || '').toString().toLowerCase());
@@ -1205,7 +1206,7 @@ export function parseBodystructure(entry) {
         // body location
         // NB! defined as a "string list" in RFC3501 but replaced in errata document with "string"
         // Errata: http://www.rfc-editor.org/errata_search.php?rfc=3501
-        if (i < node.length - 1) {
+        if (i < node.length) {
             if (node[i]) {
                 curNode.location = (node[i].value || '').toString();
             }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "2.0.8",
+    "version": "2.1.0",
     "description": "IMAP Client for Node",
     "type": "module",
     "main": "./dist/cjs/imap-flow.js",
@@ -78,7 +78,7 @@
         "types-node-legacy": "npm:@types/node@20.0.0",
         "typescript": "6.0.3",
         "typescript-eslint": "8.70.1",
-        "wrangler": "4.141.0"
+        "wrangler": "4.142.0"
     },
     "dependencies": {
         "@zone-eu/mailsplit": "5.4.17",