imapflow 2.0.6 → 2.0.8

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>;