imapflow 1.0.163 → 1.0.164

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.0.164](https://github.com/postalsys/imapflow/compare/v1.0.163...v1.0.164) (2024-07-09)
+
+
+### Bug Fixes
+
+* **api:** Add fetchAll method ([#207](https://github.com/postalsys/imapflow/issues/207)) ([bc09998](https://github.com/postalsys/imapflow/commit/bc09998270006ea6ff8430b3461619dd9b3e91c8))
+
 ## [1.0.163](https://github.com/postalsys/imapflow/compare/v1.0.162...v1.0.163) (2024-07-06)
 
 

package/lib/imap-flow.js

@@ -2010,7 +2010,7 @@ class ImapFlow extends EventEmitter {
     }
 
     /**
-     * Delete messages from currently opened mailbox. Method does not indicate info about deleted messages,
+     * Delete messages from the currently opened mailbox. Method does not indicate info about deleted messages,
      * instead you should be using {@link ImapFlow#expunge} event for this
      *
      * @param {SequenceString | Number[] | SearchObject} range Range to filter the messages
@@ -2121,7 +2121,7 @@ class ImapFlow extends EventEmitter {
     }
 
     /**
-     * Search messages from currently opened mailbox
+     * Search messages from the currently opened mailbox
      *
      * @param {SearchObject} query Query to filter the messages
      * @param {Object} [options]
@@ -2240,7 +2240,7 @@ class ImapFlow extends EventEmitter {
      */
 
     /**
-     * Fetch messages from currently opened mailbox
+     * Fetch messages from the currently opened mailbox
      *
      * @param {SequenceString | Number[] | SearchObject} range Range of messages to fetch
      * @param {FetchQueryObject} query Fetch query
@@ -2353,7 +2353,38 @@ class ImapFlow extends EventEmitter {
     }
 
     /**
-     * Fetch a single message from currently opened mailbox
+     * Fetch messages from the currently opened mailbox.
+     *
+     * This method will fetch all messages before resolving the promise, unlike .fetch(), which
+     * is an async generator. Do not use large ranges like 1:*, as this might exhaust all available
+     * memory if the mailbox contains a large number of emails.
+     * @param {SequenceString | Number[] | SearchObject} range Range of messages to fetch
+     * @param {FetchQueryObject} query Fetch query
+     * @param {Object} [options]
+     * @param {Boolean} [options.uid] If `true` then uses UID numbers instead of sequence numbers for `range`
+     * @param {BigInt} [options.changedSince] If set then only messages with a higher modseq value are returned. Ignored if server does not support `CONDSTORE` extension.
+     * @param {Boolean} [options.binary=false] If `true` then requests a binary response if the server supports this
+     * @returns {Promise<FetchMessageObject[]>} Array of Message data object
+     *
+     * @example
+     * let mailbox = await client.mailboxOpen('INBOX');
+     * // fetch UID for all messages in a mailbox
+     * const messages = await client.fetchAll('1:*', {uid: true});
+     * for (let msg of messages){
+     *     console.log(msg.uid);
+     * }
+     */
+    async fetchAll(range, query, options) {
+        const results = [];
+        const generator = this.fetch(range, query, options);
+        for await (const message of generator) {
+            results.push(message);
+        }
+        return results;
+    }
+
+    /**
+     * Fetch a single message from the currently opened mailbox
      *
      * @param {SequenceString} seq Single UID or sequence number of the message to fetch for
      * @param {FetchQueryObject} query Fetch query

package/lib/types.d.ts

@@ -355,7 +355,7 @@ declare module "imapflow" {
             unchangedSince?: bigint;
         }): Promise<Boolean>;
         /**
-         * Delete messages from currently opened mailbox. Method does not indicate info about deleted messages,
+         * Delete messages from the currently opened mailbox. Method does not indicate info about deleted messages,
          * instead you should be using {@link ImapFlow#expunge} event for this
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
@@ -410,7 +410,7 @@ declare module "imapflow" {
             uid?: boolean;
         }): Promise<CopyResponseObject>;
         /**
-         * Search messages from currently opened mailbox
+         * Search messages from the currently opened mailbox
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
          * // find all unseen messages
@@ -431,7 +431,7 @@ declare module "imapflow" {
             uid?: boolean;
         }): Promise<Number[]>;
         /**
-         * Fetch messages from currently opened mailbox
+         * Fetch messages from the currently opened mailbox
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
          * // fetch UID for all messages in a mailbox
@@ -452,7 +452,32 @@ declare module "imapflow" {
             binary?: boolean;
         }): void;
         /**
-         * Fetch a single message from currently opened mailbox
+         * Fetch messages from the currently opened mailbox.
+         *
+         * This method will fetch all messages before resolving the promise, unlike .fetch(), which
+         * is an async generator. Do not use large ranges like 1:*, as this might exhaust all available
+         * memory if the mailbox contains a large number of emails.
+         * @example
+         * let mailbox = await client.mailboxOpen('INBOX');
+         * // fetch UID for all messages in a mailbox
+         * const messages = await client.fetchAll('1:*', {uid: true});
+         * for (let msg of messages){
+         *     console.log(msg.uid);
+         * }
+         * @param range - Range of messages to fetch
+         * @param query - Fetch query
+         * @param [options.uid] - If `true` then uses UID numbers instead of sequence numbers for `range`
+         * @param [options.changedSince] - If set then only messages with a higher modseq value are returned. Ignored if server does not support `CONDSTORE` extension.
+         * @param [options.binary = false] - If `true` then requests a binary response if the server supports this
+         * @returns Array of Message data object
+         */
+        fetchAll(range: SequenceString | Number[] | SearchObject, query: FetchQueryObject, options?: {
+            uid?: boolean;
+            changedSince?: bigint;
+            binary?: boolean;
+        }): Promise<FetchMessageObject[]>;
+        /**
+         * Fetch a single message from the currently opened mailbox
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
          * // fetch UID for the last email in the selected mailbox

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.163",
+    "version": "1.0.164",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {