imapflow 1.0.128 → 1.0.130

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+-   1.0.129 - 2023-06-12
+
+    -   Bumped deps for maintenance
+
 -   1.0.127 - 2023-04-10
 
     -   Use default Node.js TLS settings

package/lib/imap-flow.js

@@ -123,7 +123,7 @@ class ImapFlow extends EventEmitter {
      * @param {Boolean} [options.tls.rejectUnauthorized=true] if `false` then client accepts self-signed and expired certificates from the server
      * @param {String} [options.tls.minVersion=TLSv1.2] To improvde security you might need to use something newer, eg *'TLSv1.2'*
      * @param {Number} [options.tls.minDHSize=1024] Minimum size of the DH parameter in bits to accept a TLS connection
-     * @param {Object} [options.logger] Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)` and `error(obj)` methods. If not provided then ImapFlow logs to console using pino format
+     * @param {Object} [options.logger] Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)` and `error(obj)` methods. If not provided then ImapFlow logs to console using pino format. Can be disabled by setting to `false`
      * @param {Boolean} [options.logRaw=false] If true then log data read from and written to socket encoded in base64
      * @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

package/lib/tools.js

@@ -165,6 +165,10 @@ module.exports = {
                     listed: !!folder.listed
                 };
 
+                if (folder.delimiter) {
+                    data.delimiter = folder.delimiter;
+                }
+
                 if (folder.specialUse) {
                     data.specialUse = folder.specialUse;
                 }
@@ -420,13 +424,99 @@ module.exports = {
         return envelope;
     },
 
+    getStructuredParams(arr) {
+        let key;
+
+        let params = {};
+
+        [].concat(arr || []).forEach((val, j) => {
+            if (j % 2) {
+                params[key] = libmime.decodeWords(((val && val.value) || '').toString());
+            } else {
+                key = ((val && val.value) || '').toString().toLowerCase();
+            }
+        });
+
+        // preprocess values
+        Object.keys(params).forEach(key => {
+            let actualKey;
+            let nr;
+            let value;
+
+            let match = key.match(/\*((\d+)\*?)?$/);
+
+            if (!match) {
+                // nothing to do here, does not seem like a continuation param
+                return;
+            }
+
+            actualKey = key.substr(0, match.index).toLowerCase();
+            nr = Number(match[2]) || 0;
+
+            if (!params[actualKey] || typeof params[actualKey] !== 'object') {
+                params[actualKey] = {
+                    charset: false,
+                    values: []
+                };
+            }
+
+            value = params[key];
+
+            if (nr === 0 && match[0].charAt(match[0].length - 1) === '*' && (match = value.match(/^([^']*)'[^']*'(.*)$/))) {
+                params[actualKey].charset = match[1] || 'utf-8';
+                value = match[2];
+            }
+
+            params[actualKey].values.push({ nr, value });
+
+            // remove the old reference
+            delete params[key];
+        });
+
+        // concatenate split rfc2231 strings and convert encoded strings to mime encoded words
+        Object.keys(params).forEach(key => {
+            let value;
+            if (params[key] && Array.isArray(params[key].values)) {
+                value = params[key].values
+                    .sort((a, b) => a.nr - b.nr)
+                    .map(val => (val && val.value) || '')
+                    .join('');
+
+                if (params[key].charset) {
+                    // convert "%AB" to "=?charset?Q?=AB?=" and then to unicode
+                    params[key] = libmime.decodeWords(
+                        '=?' +
+                            params[key].charset +
+                            '?Q?' +
+                            value
+                                // fix invalidly encoded chars
+                                .replace(/[=?_\s]/g, s => {
+                                    let c = s.charCodeAt(0).toString(16);
+                                    if (s === ' ') {
+                                        return '_';
+                                    } else {
+                                        return '%' + (c.length < 2 ? '0' : '') + c;
+                                    }
+                                })
+                                // change from urlencoding to percent encoding
+                                .replace(/%/g, '=') +
+                            '?='
+                    );
+                } else {
+                    params[key] = libmime.decodeWords(value);
+                }
+            }
+        });
+
+        return params;
+    },
+
     parseBodystructure(entry) {
         let walk = (node, path) => {
             path = path || [];
 
             let curNode = {},
                 i = 0,
-                key,
                 part = 0;
 
             if (path.length) {
@@ -449,14 +539,7 @@ module.exports = {
                 // body parameter parenthesized list
                 if (i < node.length - 1) {
                     if (node[i]) {
-                        curNode.parameters = {};
-                        [].concat(node[i] || []).forEach((val, j) => {
-                            if (j % 2) {
-                                curNode.parameters[key] = libmime.decodeWords(((val && val.value) || '').toString());
-                            } else {
-                                key = ((val && val.value) || '').toString().toLowerCase();
-                            }
-                        });
+                        curNode.parameters = this.getStructuredParams(node[i]);
                     }
                     i++;
                 }
@@ -466,14 +549,7 @@ module.exports = {
 
                 // body parameter parenthesized list
                 if (node[i]) {
-                    curNode.parameters = {};
-                    [].concat(node[i] || []).forEach((val, j) => {
-                        if (j % 2) {
-                            curNode.parameters[key] = libmime.decodeWords(((val && val.value) || '').toString());
-                        } else {
-                            key = ((val && val.value) || '').toString().toLowerCase();
-                        }
-                    });
+                    curNode.parameters = this.getStructuredParams(node[i]);
                 }
                 i++;
 
@@ -554,14 +630,7 @@ module.exports = {
                 if (Array.isArray(node[i]) && node[i].length) {
                     curNode.disposition = ((node[i][0] || {}).value || '').toString().toLowerCase();
                     if (Array.isArray(node[i][1])) {
-                        curNode.dispositionParameters = {};
-                        [].concat(node[i][1] || []).forEach((val, j) => {
-                            if (j % 2) {
-                                curNode.dispositionParameters[key] = libmime.decodeWords(((val && val.value) || '').toString());
-                            } else {
-                                key = ((val && val.value) || '').toString().toLowerCase();
-                            }
-                        });
+                        curNode.dispositionParameters = this.getStructuredParams(node[i][1]);
                     }
                 }
                 i++;

package/lib/types.d.ts

@@ -22,7 +22,7 @@ declare module "imapflow" {
      * @param [options.tls.rejectUnauthorized = true] - if `false` then client accepts self-signed and expired certificates from the server
      * @param [options.tls.minVersion = TLSv1.2] - To improvde security you might need to use something newer, eg *'TLSv1.2'*
      * @param [options.tls.minDHSize = 1024] - Minimum size of the DH parameter in bits to accept a TLS connection
-     * @param [options.logger] - Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)` and `error(obj)` methods. If not provided then ImapFlow logs to console using pino format
+     * @param [options.logger] - Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)` and `error(obj)` methods. If not provided then ImapFlow logs to console using pino format. Can be disabled by setting to `false`
      * @param [options.logRaw = false] - If true then log data read from and written to socket encoded in base64
      * @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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.128",
+    "version": "1.0.130",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -27,19 +27,19 @@
     },
     "homepage": "https://imapflow.com/",
     "devDependencies": {
-        "@babel/eslint-parser": "7.21.3",
-        "@babel/eslint-plugin": "7.19.1",
+        "@babel/eslint-parser": "7.22.5",
+        "@babel/eslint-plugin": "7.22.5",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.21.4",
-        "@types/node": "18.15.11",
+        "@babel/preset-env": "7.22.5",
+        "@types/node": "20.3.1",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.38.0",
+        "eslint": "8.42.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.8.0",
         "grunt": "1.6.1",
         "grunt-cli": "1.4.3",
         "grunt-contrib-nodeunit": "5.0.0",
-        "grunt-eslint": "24.0.1",
+        "grunt-eslint": "24.1.0",
         "jsdoc": "3.6.11",
         "st": "3.0.0",
         "tsd-jsdoc": "2.5.0"
@@ -51,8 +51,8 @@
         "libmime": "5.2.1",
         "libqp": "2.0.1",
         "mailsplit": "5.4.0",
-        "nodemailer": "6.9.1",
-        "pino": "8.11.0",
+        "nodemailer": "6.9.3",
+        "pino": "8.14.1",
         "socks": "2.7.1"
     }
 }