imapflow 1.0.162 → 1.0.164

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # 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)
+
+
+### Bug Fixes
+
+* **parser:** parse subfolders with square brackets ([0d0e8a6](https://github.com/postalsys/imapflow/commit/0d0e8a6ea379adf11594684d49a1ce5031339939))
+* **socket:** Use destroy() instead of destroySoon() ([830c2d1](https://github.com/postalsys/imapflow/commit/830c2d18f3d27eb12dc6babe4edd37fed5f65490))
+
 ## [1.0.162](https://github.com/postalsys/imapflow/compare/v1.0.161...v1.0.162) (2024-05-07)
 
 

package/lib/handler/token-parser.js

@@ -355,10 +355,16 @@ class TokenParser {
                     if (chr === '[') {
                         // allowed only for selected elements
                         if (['BODY', 'BODY.PEEK', 'BINARY', 'BINARY.PEEK'].indexOf(this.currentNode.value.toUpperCase()) < 0) {
-                            let error = new Error(`Unexpected section start char [ at position ${this.pos + i} [E14]`);
-                            error.code = 'ParserError14';
-                            error.parserContext = { input: this.str, pos: this.pos + i, chr };
-                            throw error;
+                            if (/[./]/.test(this.currentNode.value)) {
+                                // could be a path
+                                this.currentNode.value += chr;
+                                break;
+                            } else {
+                                let error = new Error(`Unexpected section start char [ at position ${this.pos + i} [E14]`);
+                                error.code = 'ParserError14';
+                                error.parserContext = { input: this.str, pos: this.pos + i, chr };
+                                throw error;
+                            }
                         }
                         this.currentNode.endPos = this.pos + i;
                         this.currentNode = this.createNode(this.currentNode.parentNode, this.pos + i);

package/lib/imap-flow.js

@@ -768,11 +768,7 @@ class ImapFlow extends EventEmitter {
         this.writeSocket.destroySoon = () => {
             try {
                 if (this.socket) {
-                    if (typeof this.socket.destroySoon === 'function') {
-                        this.socket.destroySoon();
-                    } else {
-                        this.socket.destroy();
-                    }
+                    this.socket.destroy();
                 }
                 this.writeSocket.end();
             } catch (err) {
@@ -1484,11 +1480,7 @@ class ImapFlow extends EventEmitter {
 
         if (this.writeSocket && !this.writeSocket.destroyed) {
             try {
-                if (typeof this.writeSocket.destroySoon === 'function') {
-                    this.writeSocket.destroySoon();
-                } else {
-                    this.writeSocket.destroy();
-                }
+                this.writeSocket.destroy();
             } catch (err) {
                 this.log.error({ err, cid: this.id });
             }
@@ -1496,11 +1488,7 @@ class ImapFlow extends EventEmitter {
 
         if (this.socket && !this.socket.destroyed && this.writeSocket !== this.socket) {
             try {
-                if (typeof this.socket.destroySoon === 'function') {
-                    this.socket.destroySoon();
-                } else {
-                    this.socket.destroy();
-                }
+                this.socket.destroy();
             } catch (err) {
                 this.log.error({ err, cid: this.id });
             }
@@ -2022,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
@@ -2133,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]
@@ -2252,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
@@ -2365,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.162",
+    "version": "1.0.164",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -28,11 +28,11 @@
     },
     "homepage": "https://imapflow.com/",
     "devDependencies": {
-        "@babel/eslint-parser": "7.24.5",
-        "@babel/eslint-plugin": "7.24.5",
+        "@babel/eslint-parser": "7.24.7",
+        "@babel/eslint-plugin": "7.24.7",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.24.5",
-        "@types/node": "20.12.8",
+        "@babel/preset-env": "7.24.7",
+        "@types/node": "20.14.10",
         "eslint": "8.57.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.1.0",
@@ -46,14 +46,14 @@
         "tsd-jsdoc": "2.5.0"
     },
     "dependencies": {
-        "encoding-japanese": "2.1.0",
+        "encoding-japanese": "2.2.0",
         "iconv-lite": "0.6.3",
         "libbase64": "1.3.0",
         "libmime": "5.3.5",
         "libqp": "2.1.0",
         "mailsplit": "5.4.0",
-        "nodemailer": "6.9.13",
-        "pino": "9.0.0",
+        "nodemailer": "6.9.14",
+        "pino": "9.2.0",
         "socks": "2.8.3"
     }
 }

package/test/imap-parser-test.js

@@ -992,3 +992,13 @@ module.exports['IMAP Parser, BAD with throttling'] = test =>
         test.equal(parsed.command, 'BAD');
         test.deepEqual(parsed.attributes, [{ type: 'TEXT', value: 'Request is throttled. Suggested Backoff Time: 92415 milliseconds' }]);
     });
+
+module.exports['IMAP Parser, subfolder square bracket'] = test =>
+    asyncWrapper(test, async test => {
+        let parsed = await parser('* LIST (\\UnMarked) "." INBOX.[Airmail].Snooze');
+        test.deepEqual(parsed.attributes, [
+            [{ type: 'ATOM', value: '\\UnMarked' }],
+            { type: 'STRING', value: '.' },
+            { type: 'ATOM', value: 'INBOX.[Airmail].Snooze' }
+        ]);
+    });