imapflow 2.0.7 → 2.1.0

package/dist/cjs/commands/select.js

@@ -59,7 +59,7 @@ const VALUED_RESPONSE_CODES = Object.assign(Object.create(null), {
  * @throws If the SELECT/EXAMINE command fails
  */
 async function select(connection, pathInput, options) {
-    if (![connection.states.AUTHENTICATED, connection.states.SELECTED].includes(connection.state)) {
+    if (!(0, tools_js_1.isAuthenticatedState)(connection)) {
         // nothing to do here
         return;
     }
@@ -95,12 +95,16 @@ async function select(connection, pathInput, options) {
         // QRESYNC (RFC 7162): allows efficient mailbox resynchronization by sending
         // the last known UIDVALIDITY and HIGHESTMODSEQ. Server responds with only
         // the changes (new flags, expunged UIDs) since that point.
+        // The caller may pass UIDVALIDITY as a bigint, a number or a string. It is parsed once,
+        // so the value that is sent is also the one checked against the server's below, and a
+        // value that is not a plain decimal skips QRESYNC instead of reaching the server.
+        let uidValidity = options.uidValidity !== undefined ? (0, tools_js_1.parseBigIntValue)(String(options.uidValidity)) : false;
         let extraArgs = [];
-        if (connection.enabled.has('QRESYNC') && options.changedSince && options.uidValidity) {
+        if (connection.enabled.has('QRESYNC') && options.changedSince && uidValidity) {
             extraArgs.push([
                 { type: 'ATOM', value: 'QRESYNC' },
                 [
-                    { type: 'ATOM', value: options.uidValidity?.toString() },
+                    { type: 'ATOM', value: uidValidity.toString() },
                     { type: 'ATOM', value: options.changedSince.toString() }
                 ]
             ]);
@@ -205,7 +209,7 @@ async function select(connection, pathInput, options) {
         // QRESYNC results are only valid if UIDVALIDITY matches, HIGHESTMODSEQ is
         // present, and the mailbox supports mod-sequences. If any condition fails,
         // the client cannot trust the incremental updates and must do a full resync.
-        if (map.qresync && (options.uidValidity !== map.uidValidity || !map.highestModseq || map.noModseq)) {
+        if (map.qresync && (uidValidity !== map.uidValidity || !map.highestModseq || map.noModseq)) {
             map.qresync = false;
         }
         // Transition mailbox state: save previous mailbox reference, temporarily
@@ -215,7 +219,7 @@ async function select(connection, pathInput, options) {
         // Emit mailboxClose if we're switching from a different mailbox.
         // Re-selecting the same mailbox (e.g., for resync) does not trigger close/open.
         if (currentMailbox && currentMailbox.path !== path) {
-            connection.emit('mailboxClose', currentMailbox);
+            (0, tools_js_1.emitSafe)(connection, 'mailboxClose', currentMailbox);
         }
         connection.mailbox = map;
         // Save the SELECT command for potential re-use (e.g., NOOP fallback polling
@@ -223,13 +227,13 @@ async function select(connection, pathInput, options) {
         connection.currentSelectCommand = selectCommand;
         connection.state = connection.states.SELECTED;
         if (!currentMailbox || currentMailbox.path !== path) {
-            connection.emit('mailboxOpen', connection.mailbox);
+            (0, tools_js_1.emitSafe)(connection, 'mailboxOpen', connection.mailbox);
         }
         response.next();
         return map;
     }
     catch (err) {
-        await (0, tools_js_1.enhanceCommandError)(err);
+        await (0, tools_js_1.reportCommandError)(connection, err);
         // If SELECT/EXAMINE fails while a mailbox was already selected, we must
         // reset to AUTHENTICATED state since the server has implicitly deselected
         // the previous mailbox on failure (RFC 3501 Section 6.3.1).
@@ -239,10 +243,9 @@ async function select(connection, pathInput, options) {
             connection.currentSelectCommand = false;
             connection.state = connection.states.AUTHENTICATED;
             if (currentMailbox) {
-                connection.emit('mailboxClose', currentMailbox);
+                (0, tools_js_1.emitSafe)(connection, 'mailboxClose', currentMailbox);
             }
         }
-        connection.log.warn({ err, cid: connection.id });
         throw err;
     }
 }

package/dist/cjs/commands/status.js

@@ -6,19 +6,18 @@ const status_fields_js_1 = require("./status-fields.js");
 // STATUS fields that also refresh the live mailbox state when the queried mailbox is the
 // currently selected one. Keyed by the output property name parseStatusList() reports.
 const MAILBOX_UPDATERS = {
-    messages: (value, connection, path) => {
-        let mailbox = connection.mailbox;
+    messages: (value, mailbox, connection, path) => {
         let prevCount = mailbox.exists;
         if (prevCount !== value) {
             mailbox.exists = value;
-            connection.emit('exists', { path, count: value, prevCount });
+            (0, tools_js_1.emitSafe)(connection, 'exists', { path, count: value, prevCount });
         }
     },
-    uidNext: (value, connection) => {
-        connection.mailbox.uidNext = value;
+    uidNext: (value, mailbox) => {
+        mailbox.uidNext = value;
     },
-    highestModseq: (value, connection) => {
-        connection.mailbox.highestModseq = value;
+    highestModseq: (value, mailbox) => {
+        mailbox.highestModseq = value;
     }
 };
 /**
@@ -31,7 +30,7 @@ const MAILBOX_UPDATERS = {
  * @throws {Error} If the mailbox does not exist
  */
 async function status(connection, path, query) {
-    if (![connection.states.AUTHENTICATED, connection.states.SELECTED].includes(connection.state) || !path) {
+    if (!(0, tools_js_1.isAuthenticatedState)(connection) || !path) {
         // nothing to do here
         return false;
     }
@@ -62,7 +61,8 @@ async function status(connection, path, query) {
                 STATUS: async (untagged) => {
                     // If querying the currently selected mailbox, also update the
                     // connection's live mailbox state and emit events for changes.
-                    let updateCurrent = connection.state === connection.states.SELECTED && path === connection.mailbox.path;
+                    let selected = (0, tools_js_1.getSelectedMailbox)(connection);
+                    let currentMailbox = selected && selected.path === path ? selected : false;
                     let list = untagged.attributes && Array.isArray(untagged.attributes[1]) ? untagged.attributes[1] : false;
                     if (!list) {
                         return;
@@ -70,8 +70,8 @@ async function status(connection, path, query) {
                     (0, status_fields_js_1.parseStatusList)(list, (key, value) => {
                         map[key] = value;
                         let updater = MAILBOX_UPDATERS[key];
-                        if (updateCurrent && updater) {
-                            updater(value, connection, path);
+                        if (currentMailbox && updater) {
+                            updater(value, currentMailbox, connection, path);
                         }
                     });
                 }

package/dist/cjs/commands/store.js

@@ -12,7 +12,8 @@ const tools_js_1 = require("../tools.js");
  * @returns True on success, false on failure or if nothing to do
  */
 async function store(connection, range, flags, options) {
-    if (connection.state !== connection.states.SELECTED || !range || (options.useLabels && !connection.capabilities.has('X-GM-EXT-1'))) {
+    let mailbox = (0, tools_js_1.getSelectedMailbox)(connection);
+    if (!mailbox || !range || (options.useLabels && !connection.capabilities.has('X-GM-EXT-1'))) {
         // nothing to do here
         return false;
     }
@@ -48,7 +49,7 @@ async function store(connection, range, flags, options) {
     flags = (Array.isArray(flags) ? flags : [].concat(flags || []))
         .map(flag => {
         let formatted = (0, tools_js_1.formatFlag)(flag);
-        if (!(0, tools_js_1.canUseFlag)(connection.mailbox, formatted) && options.operation !== 'remove') {
+        if (!(0, tools_js_1.canUseFlag)(mailbox, formatted) && options.operation !== 'remove') {
             return false;
         }
         return formatted;
@@ -65,7 +66,7 @@ async function store(connection, range, flags, options) {
     ];
     // CONDSTORE (RFC 7162): UNCHANGEDSINCE modifier prevents updating messages whose
     // mod-sequence is higher than the specified value, avoiding overwriting concurrent changes.
-    if (options.unchangedSince && connection.enabled.has('CONDSTORE') && !connection.mailbox.noModseq) {
+    if (options.unchangedSince && connection.enabled.has('CONDSTORE') && !mailbox.noModseq) {
         attributes.push([
             {
                 type: 'ATOM',
@@ -84,8 +85,7 @@ async function store(connection, range, flags, options) {
         return true;
     }
     catch (err) {
-        await (0, tools_js_1.enhanceCommandError)(err);
-        connection.log.warn({ err, cid: connection.id });
+        await (0, tools_js_1.reportCommandError)(connection, err);
         return false;
     }
 }

package/dist/cjs/commands/subscribe.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = subscribe;
-const tools_js_1 = require("../tools.js");
+const subscription_js_1 = require("./subscription.js");
 /**
  * Subscribes to a mailbox.
  *
@@ -10,22 +10,7 @@ const tools_js_1 = require("../tools.js");
  * @returns True on success, false on failure, or undefined if preconditions not met
  */
 async function subscribe(connection, path) {
-    if (![connection.states.AUTHENTICATED, connection.states.SELECTED].includes(connection.state)) {
-        // nothing to do here
-        return;
-    }
-    path = (0, tools_js_1.normalizePath)(connection, path);
-    let response;
-    try {
-        response = await connection.exec('SUBSCRIBE', [{ type: 'ATOM', value: (0, tools_js_1.encodePath)(connection, path) }]);
-        response.next();
-        return true;
-    }
-    catch (err) {
-        await (0, tools_js_1.enhanceCommandError)(err);
-        connection.log.warn({ err, cid: connection.id });
-        return false;
-    }
+    return await (0, subscription_js_1.setSubscription)(connection, 'SUBSCRIBE', path);
 }
 module.exports = exports.default;
 Object.defineProperty(module.exports, 'default', { value: exports.default, enumerable: false, writable: true, configurable: true });

package/dist/cjs/commands/subscription.d.ts

@@ -0,0 +1,10 @@
+import type { ImapFlow } from '../imap-flow.js';
+/**
+ * Runs SUBSCRIBE or UNSUBSCRIBE for a mailbox, the shared body of the two commands.
+ *
+ * @param connection - IMAP connection instance
+ * @param command - SUBSCRIBE or UNSUBSCRIBE
+ * @param path - Mailbox path
+ * @returns True on success, false on failure, or undefined if preconditions not met
+ */
+export declare function setSubscription(connection: ImapFlow, command: 'SUBSCRIBE' | 'UNSUBSCRIBE', path: string | string[]): Promise<boolean | undefined>;

package/dist/cjs/commands/subscription.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setSubscription = setSubscription;
+const tools_js_1 = require("../tools.js");
+/**
+ * Runs SUBSCRIBE or UNSUBSCRIBE for a mailbox, the shared body of the two commands.
+ *
+ * @param connection - IMAP connection instance
+ * @param command - SUBSCRIBE or UNSUBSCRIBE
+ * @param path - Mailbox path
+ * @returns True on success, false on failure, or undefined if preconditions not met
+ */
+async function setSubscription(connection, command, path) {
+    if (!(0, tools_js_1.isAuthenticatedState)(connection)) {
+        // nothing to do here
+        return;
+    }
+    path = (0, tools_js_1.normalizePath)(connection, path);
+    let response;
+    try {
+        response = await connection.exec(command, [{ type: 'ATOM', value: (0, tools_js_1.encodePath)(connection, path) }]);
+        response.next();
+        return true;
+    }
+    catch (err) {
+        await (0, tools_js_1.reportCommandError)(connection, err);
+        return false;
+    }
+}

package/dist/cjs/commands/unsubscribe.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = unsubscribe;
-const tools_js_1 = require("../tools.js");
+const subscription_js_1 = require("./subscription.js");
 /**
  * Unsubscribes from a mailbox.
  *
@@ -10,22 +10,7 @@ const tools_js_1 = require("../tools.js");
  * @returns True on success, false on failure, or undefined if preconditions not met
  */
 async function unsubscribe(connection, path) {
-    if (![connection.states.AUTHENTICATED, connection.states.SELECTED].includes(connection.state)) {
-        // nothing to do here
-        return;
-    }
-    path = (0, tools_js_1.normalizePath)(connection, path);
-    let response;
-    try {
-        response = await connection.exec('UNSUBSCRIBE', [{ type: 'ATOM', value: (0, tools_js_1.encodePath)(connection, path) }]);
-        response.next();
-        return true;
-    }
-    catch (err) {
-        await (0, tools_js_1.enhanceCommandError)(err);
-        connection.log.warn({ err, cid: connection.id });
-        return false;
-    }
+    return await (0, subscription_js_1.setSubscription)(connection, 'UNSUBSCRIBE', path);
 }
 module.exports = exports.default;
 Object.defineProperty(module.exports, 'default', { value: exports.default, enumerable: false, writable: true, configurable: true });

package/dist/cjs/download.d.ts

@@ -0,0 +1,22 @@
+import type { ImapFlow } from './imap-flow.js';
+import type { DownloadManyOptions, DownloadManyResult, DownloadNotFound, DownloadObject, DownloadOptions, SequenceString } from './types.js';
+/**
+ * Implements ImapFlow.download(), see its documentation
+ *
+ * @param client - Connection to download from
+ * @param range - UID or sequence number of the message
+ * @param part - Body part to download, the whole message when not set
+ * @param options - Download options
+ * @returns The download, or an empty object when there is nothing to download
+ */
+export declare function downloadMessage(client: ImapFlow, range: SequenceString, part?: string | undefined, options?: DownloadOptions | undefined): Promise<DownloadObject | DownloadNotFound>;
+/**
+ * Implements ImapFlow.downloadMany(), see its documentation
+ *
+ * @param client - Connection to download from
+ * @param range - UID or sequence number of the message
+ * @param parts - Body parts to download
+ * @param options - Download options
+ * @returns Downloaded parts keyed by part number
+ */
+export declare function downloadMessageParts(client: ImapFlow, range: SequenceString, parts: string[], options?: DownloadManyOptions | undefined): Promise<DownloadManyResult>;