imapflow 1.0.80 → 1.0.84

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+-   1.0.84 - 2022-02-17
+
+    -   QRESYNC tweaks
+
+-   1.0.83 - 2022-02-16
+
+    -   QRESYNC tweaks
+
+-   1.0.82 - 2022-02-15
+
+    -   Added extra option `expungeHandler`
+
+-   1.0.81 - 2022-02-15
+
+    -   Added support for the QRESYNC extension and untagged VANISHED responses
+
 -   1.0.80 - 2022-02-07
 
     -   Added support for the missing NOMODSEQ mailbox modifier

package/lib/commands/expunge.js

@@ -20,6 +20,17 @@ module.exports = async (connection, range, options) => {
     let response;
     try {
         response = await connection.exec(command, attributes);
+
+        // A OK [HIGHESTMODSEQ 9122] Expunge completed (0.010 + 0.000 + 0.012 secs).
+        let section = response.response.attributes && response.response.attributes[0] && response.response.attributes[0].section;
+        let responseCode = section && section.length && section[0] && typeof section[0].value === 'string' ? section[0].value : '';
+        if (responseCode.toUpperCase() === 'HIGHESTMODSEQ') {
+            let highestModseq = section[1] && typeof section[1].value === 'string' && !isNaN(section[1].value) ? BigInt(section[1].value) : false;
+            if (highestModseq && (!connection.mailbox.highestModseq || highestModseq > connection.mailbox.highestModseq)) {
+                connection.mailbox.highestModseq = highestModseq;
+            }
+        }
+
         response.next();
         return true;
     } catch (err) {

package/lib/commands/fetch.js

@@ -138,7 +138,7 @@ module.exports = async (connection, range, query, options) => {
         attributes.push(queryStructure);
 
         if (options.changedSince && connection.enabled.has('CONDSTORE') && !mailbox.noModseq) {
-            attributes.push([
+            let changedSinceArgs = [
                 {
                     type: 'ATOM',
                     value: 'CHANGEDSINCE'
@@ -147,7 +147,16 @@ module.exports = async (connection, range, query, options) => {
                     type: 'ATOM',
                     value: options.changedSince.toString()
                 }
-            ]);
+            ];
+
+            if (options.uid && connection.enabled.has('QRESYNC')) {
+                changedSinceArgs.push({
+                    type: 'ATOM',
+                    value: 'VANISHED'
+                });
+            }
+
+            attributes.push(changedSinceArgs);
         }
 
         response = await connection.exec(options.uid ? 'UID FETCH' : 'FETCH', attributes, {

package/lib/commands/select.js

@@ -21,6 +21,7 @@ module.exports = async (connection, path, options) => {
             connection.folders.set(folder.path, folder);
         });
     }
+
     let folderListData = connection.folders.has(path) ? connection.folders.get(path) : false;
 
     let response;
@@ -33,7 +34,20 @@ module.exports = async (connection, path, options) => {
                 }
             });
         }
-        response = await connection.exec(!options.readOnly ? 'SELECT' : 'EXAMINE', [{ type: 'ATOM', value: path }], {
+
+        let extraArgs = [];
+        if (connection.enabled.has('QRESYNC') && options.changedSince && options.uidValidity) {
+            extraArgs.push([
+                { type: 'ATOM', value: 'QRESYNC' },
+                [
+                    { type: 'ATOM', value: options.uidValidity.toString() },
+                    { type: 'ATOM', value: options.changedSince.toString() }
+                ]
+            ]);
+            map.qresync = true;
+        }
+
+        response = await connection.exec(!options.readOnly ? 'SELECT' : 'EXAMINE', [{ type: 'ATOM', value: path }].concat(extraArgs || []), {
             untagged: {
                 OK: async untagged => {
                     if (!untagged.attributes || !untagged.attributes.length) {
@@ -110,6 +124,21 @@ module.exports = async (connection, path, options) => {
                     }
 
                     map.exists = num;
+                },
+                VANISHED: async untagged => {
+                    await connection.untaggedVanished(
+                        untagged,
+                        // mailbox is not yet open, so use a dummy mailbox object
+                        { path, uidNext: false, uidValidity: false }
+                    );
+                },
+                // we should only get an untagged FETCH for a SELECT/EXAMINE if QRESYNC was asked for
+                FETCH: async untagged => {
+                    await connection.untaggedFetch(
+                        untagged,
+                        // mailbox is not yet open, so use a dummy mailbox object
+                        { path, uidNext: false, uidValidity: false }
+                    );
                 }
             }
         });
@@ -127,6 +156,19 @@ module.exports = async (connection, path, options) => {
             }
         }
 
+        if (
+            map.qresync &&
+            // UIDVALIDITY must be the same
+            (options.uidValidity !== map.uidValidity ||
+                // HIGHESTMODSEQ response must be present
+                !map.highestModseq ||
+                // NOMODSEQ is not allowed
+                map.noModseq)
+        ) {
+            // QRESYNC does not apply here, so unset it
+            map.qresync = false;
+        }
+
         let currentMailbox = connection.mailbox;
         connection.mailbox = false;
 

package/lib/imap-flow.js

@@ -29,7 +29,7 @@ const { PassThrough } = require('stream');
 
 const { proxyConnection } = require('./proxy-connection');
 
-const { comparePaths, updateCapabilities, getFolderTree, formatMessageResponse, getDecoder, packMessageRange, normalizePath } = require('./tools');
+const { comparePaths, updateCapabilities, getFolderTree, formatMessageResponse, getDecoder, packMessageRange, normalizePath, expandRange } = require('./tools');
 
 const imapCommands = require('./imap-commands.js');
 
@@ -128,9 +128,10 @@ class ImapFlow extends EventEmitter {
      * @param {Boolean} [options.emitLogs=false] If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
      * @param {Boolean} [options.verifyOnly=false] If `true` then logs out automatically after successful authentication
      * @param {Boolean} [options.proxy] Optional proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`) proxies
+     * @param {Boolean} [options.qresync=false] If true, then enables QRESYNC support. EXPUNGE notifications will include `uid` property instead of `seq`
      */
     constructor(options) {
-        super();
+        super({ captureRejections: true });
 
         this.options = options || {};
 
@@ -617,7 +618,7 @@ class ImapFlow extends EventEmitter {
         }
 
         // enable extensions if possible
-        await this.run('ENABLE', ['CONDSTORE', 'UTF8=ACCEPT']);
+        await this.run('ENABLE', ['CONDSTORE', 'UTF8=ACCEPT'].concat(this.options.qresync ? 'QRESYNC' : []));
 
         this.usable = true;
     }
@@ -941,23 +942,76 @@ class ImapFlow extends EventEmitter {
         let seq = Number(untagged.command);
         if (seq && seq <= this.mailbox.exists) {
             this.mailbox.exists--;
-            this.emit('expunge', {
+            let payload = {
                 path: this.mailbox.path,
-                seq
-            });
+                seq,
+                vanished: false
+            };
+
+            if (typeof this.options.expungeHandler === 'function') {
+                try {
+                    await this.options.expungeHandler(payload);
+                } catch (err) {
+                    this.log.error({ msg: 'Failed to notify expunge event', payload, error: err, cid: this.id });
+                }
+            } else {
+                this.emit('expunge', payload);
+            }
         }
     }
 
-    async untaggedFetch(untagged) {
-        if (!this.mailbox) {
+    async untaggedVanished(untagged, mailbox) {
+        mailbox = mailbox || this.mailbox;
+        if (!mailbox) {
             // mailbox closed, ignore
             return;
         }
 
-        let message = await formatMessageResponse(untagged, this.mailbox);
+        let tags = [];
+        let uids = false;
+
+        if (untagged.attributes.length > 1 && Array.isArray(untagged.attributes[0])) {
+            tags = untagged.attributes[0].map(entry => (typeof entry.value === 'string' ? entry.value.toUpperCase() : false)).filter(value => value);
+            untagged.attributes.shift();
+        }
+
+        if (untagged.attributes[0] && typeof untagged.attributes[0].value === 'string') {
+            uids = untagged.attributes[0].value;
+        }
+
+        let uidList = expandRange(uids);
+
+        for (let uid of uidList) {
+            let payload = {
+                path: mailbox.path,
+                uid,
+                vanished: true,
+                earlier: tags.includes('EARLIER')
+            };
+
+            if (typeof this.options.expungeHandler === 'function') {
+                try {
+                    await this.options.expungeHandler(payload);
+                } catch (err) {
+                    this.log.error({ msg: 'Failed to notify expunge event', payload, error: err, cid: this.id });
+                }
+            } else {
+                this.emit('expunge', payload);
+            }
+        }
+    }
+
+    async untaggedFetch(untagged, mailbox) {
+        mailbox = mailbox || this.mailbox;
+        if (!mailbox) {
+            // mailbox closed, ignore
+            return;
+        }
+
+        let message = await formatMessageResponse(untagged, mailbox);
         if (message.flags) {
             let updateEvent = {
-                path: this.mailbox.path,
+                path: mailbox.path,
                 seq: message.seq
             };
 
@@ -1060,10 +1114,13 @@ class ImapFlow extends EventEmitter {
         this.untaggedHandlers.CAPABILITY = (...args) => this.untaggedCapability(...args);
         this.sectionHandlers.CAPABILITY = (...args) => this.sectionCapability(...args);
 
-        this.untaggedHandlers.FETCH = (...args) => this.untaggedFetch(...args);
         this.untaggedHandlers.EXISTS = (...args) => this.untaggedExists(...args);
         this.untaggedHandlers.EXPUNGE = (...args) => this.untaggedExpunge(...args);
 
+        // these methods take an optional second argument, so make sure that some random IMAP tag is not used as the second argument
+        this.untaggedHandlers.FETCH = untagged => this.untaggedFetch(untagged);
+        this.untaggedHandlers.VANISHED = untagged => this.untaggedVanished(untagged);
+
         let socket = false;
         if (this.options.proxy) {
             try {

package/lib/types.d.ts

@@ -27,6 +27,7 @@ declare module "imapflow" {
      * @param [options.emitLogs = false] - If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
      * @param [options.verifyOnly = false] - If `true` then logs out automatically after successful authentication
      * @param [options.proxy] - Optional proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`) proxies
+     * @param [options.qresync = false] - If true, then enables QRESYNC support. EXPUNGE notifications will include `uid` property instead of `seq`
      */
     class ImapFlow extends EventEmitter {
         constructor(options: {
@@ -52,6 +53,7 @@ declare module "imapflow" {
             emitLogs?: boolean;
             verifyOnly?: boolean;
             proxy?: boolean;
+            qresync?: boolean;
         });
         /**
          * Current module version as a static class property

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.80",
+    "version": "1.0.84",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -30,9 +30,9 @@
         "@babel/eslint-plugin": "7.16.5",
         "@babel/plugin-syntax-class-properties": "7.12.13",
         "@babel/preset-env": "7.16.11",
-        "@types/node": "17.0.15",
+        "@types/node": "17.0.18",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.8.0",
+        "eslint": "8.9.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.3.0",
         "grunt": "1.4.1",
@@ -50,7 +50,7 @@
         "libqp": "1.1.0",
         "mailsplit": "5.3.1",
         "nodemailer": "6.7.2",
-        "pino": "7.6.5",
+        "pino": "7.8.0",
         "socks": "2.6.2"
     }
 }