imapflow 1.0.82 → 1.0.85

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+-   1.0.85 - 2022-02-23
+
+    -   Trim null bytes in the beginning of IMAP responses to deal with a buggy server that pads responses with null bytes
+
+-   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`

package/lib/commands/select.js

@@ -40,10 +40,11 @@ module.exports = async (connection, path, options) => {
             extraArgs.push([
                 { type: 'ATOM', value: 'QRESYNC' },
                 [
-                    { type: 'ATOM', value: options.uidValidity },
-                    { type: 'ATOM', value: options.changedSince }
+                    { 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 || []), {
@@ -155,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/handler/imap-parser.js

@@ -6,6 +6,21 @@ const { ParserInstance } = require('./parser-instance');
 module.exports = async (command, options) => {
     options = options || {};
 
+    let nullBytesRemoved = 0;
+
+    // special case with a buggy IMAP server where responses are padded with zero bytes
+    if (command[0] === 0) {
+        // find the first non null byte and trim
+        for (let i = 0; i < command.length; i++) {
+            if (command[i] !== 0) {
+                // trim to here
+                command = command.slice(i);
+                nullBytesRemoved = i;
+                break;
+            }
+        }
+    }
+
     const parser = new ParserInstance(command, options);
     const response = {};
 
@@ -13,6 +28,10 @@ module.exports = async (command, options) => {
     await parser.getSpace();
     response.command = await parser.getCommand();
 
+    if (nullBytesRemoved) {
+        response.nullBytesRemoved = nullBytesRemoved;
+    }
+
     if (['UID', 'AUTHENTICATE'].indexOf((response.command || '').toUpperCase()) >= 0) {
         await parser.getSpace();
         response.command += ' ' + (await parser.getElement(imapFormalSyntax.command()));

package/lib/imap-flow.js

@@ -424,9 +424,9 @@ class ImapFlow extends EventEmitter {
 
             if (/^\d+$/.test(parsed.command) && parsed.attributes && parsed.attributes[0] && parsed.attributes[0].value === 'FETCH') {
                 // too many FETCH responses, might want to filter these out
-                this.log.trace({ src: 's', msg: logCompiled.toString(), cid: this.id });
+                this.log.trace({ src: 's', msg: logCompiled.toString(), cid: this.id, nullBytesRemoved: parsed.nullBytesRemoved });
             } else {
-                this.log.debug({ src: 's', msg: logCompiled.toString(), cid: this.id });
+                this.log.debug({ src: 's', msg: logCompiled.toString(), cid: this.id, nullBytesRemoved: parsed.nullBytesRemoved });
             }
 
             if (parsed.tag === '+' && this.currentRequest && this.currentRequest.options && typeof this.currentRequest.options.onPlusTag === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.82",
+    "version": "1.0.85",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -30,11 +30,11 @@
         "@babel/eslint-plugin": "7.16.5",
         "@babel/plugin-syntax-class-properties": "7.12.13",
         "@babel/preset-env": "7.16.11",
-        "@types/node": "17.0.18",
+        "@types/node": "17.0.19",
         "braintree-jsdoc-template": "3.3.0",
         "eslint": "8.9.0",
         "eslint-config-nodemailer": "1.2.0",
-        "eslint-config-prettier": "8.3.0",
+        "eslint-config-prettier": "8.4.0",
         "grunt": "1.4.1",
         "grunt-cli": "1.4.3",
         "grunt-contrib-nodeunit": "4.0.0",