imapflow 1.0.143 → 1.0.145

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.0.145](https://github.com/postalsys/imapflow/compare/v1.0.144...v1.0.145) (2023-10-26)
+
+
+### Bug Fixes
+
+* **docs:** Fixed mailbox property name in AppendResponseObject ([ca6d789](https://github.com/postalsys/imapflow/commit/ca6d789b761d3117f733ed7b026122098f4d9142))
+* **special-use:** support custom special use flags for the Archive folder ([17aa6a8](https://github.com/postalsys/imapflow/commit/17aa6a8baf180a7349fe30f897184eb8e359a498))
+
+## [1.0.144](https://github.com/postalsys/imapflow/compare/v1.0.143...v1.0.144) (2023-09-13)
+
+
+### Bug Fixes
+
+* **MS365:** Wait until responding with a throttling response ([#142](https://github.com/postalsys/imapflow/issues/142)) ([09bfb3e](https://github.com/postalsys/imapflow/commit/09bfb3e1b90bdd37bc1c9b40e9284ad4afbd5c72))
+
 ## [1.0.143](https://github.com/postalsys/imapflow/compare/v1.0.142...v1.0.143) (2023-09-04)
 
 

package/lib/commands/list.js

@@ -62,7 +62,11 @@ module.exports = async (connection, reference, mailbox, options) => {
         let specialUseHints = {};
         if (options.specialUseHints && typeof options.specialUseHints === 'object') {
             for (let type of Object.keys(options.specialUseHints)) {
-                if (['sent', 'junk', 'trash', 'drafts'].includes(type) && options.specialUseHints[type] && typeof options.specialUseHints[type] === 'string') {
+                if (
+                    ['sent', 'junk', 'trash', 'drafts', 'archive'].includes(type) &&
+                    options.specialUseHints[type] &&
+                    typeof options.specialUseHints[type] === 'string'
+                ) {
                     specialUseHints[normalizePath(connection, options.specialUseHints[type])] = `\\${type.replace(/^./, c => c.toUpperCase())}`;
                 }
             }

package/lib/imap-flow.js

@@ -561,7 +561,28 @@ class ImapFlow extends EventEmitter {
                         err.responseStatus = parsed.command.toUpperCase();
                         if (txt) {
                             err.responseText = txt;
+
+                            // MS365 throttling
+                            // tag BAD Request is throttled. Suggested Backoff Time: 92415 milliseconds
+                            if (/Request is throttled/i.test(txt) && /Backoff Time/i.test(txt)) {
+                                let throttlingMatch = txt.match(/Backoff Time[:=\s]+(\d+)/i);
+                                if (throttlingMatch && throttlingMatch[1] && !isNaN(throttlingMatch[1])) {
+                                    err.code = 'ETHROTTLE';
+                                    err.throttleReset = Number(throttlingMatch[1]);
+
+                                    let delayResponse = err.throttleReset;
+                                    if (delayResponse > 5 * 60 * 1000) {
+                                        // max delay cap
+                                        delayResponse = 5 * 60 * 1000;
+                                    }
+                                    if (delayResponse) {
+                                        this.log.warn({ msg: 'Throttling detected', err, cid: this.id, delayResponse });
+                                        await new Promise(r => setTimeout(r, delayResponse));
+                                    }
+                                }
+                            }
                         }
+
                         request.reject(err);
                         break;
                     }
@@ -1918,7 +1939,7 @@ class ImapFlow extends EventEmitter {
     /**
      * @typedef {Object} AppendResponseObject
      * @global
-     * @property {String} path full mailbox path where the message was uploaded to
+     * @property {String} destination full mailbox path where the message was uploaded to
      * @property {BigInt} [uidValidity] mailbox `UIDVALIDITY` if server has `UIDPLUS` extension enabled
      * @property {Number} [uid] UID of the uploaded message if server has `UIDPLUS` extension enabled
      * @property {Number} [seq] sequence number of the uploaded message if path is currently selected mailbox

package/lib/special-use.js

@@ -182,7 +182,7 @@ module.exports = {
             'الرسائل العشوائية',
             'هرزنامه',
             'สแปม',
-            '‎垃圾郵件',
+            '垃圾郵件',
             '垃圾邮件',
             '垃圾電郵'
         ],
@@ -275,7 +275,9 @@ module.exports = {
             '草稿',
             '草稿',
             '임시 보관함'
-        ]
+        ],
+
+        '\\Archive': ['archive']
     },
 
     specialUse(hasSpecialUseExtension, folder) {
@@ -289,7 +291,11 @@ module.exports = {
         }
 
         if (!result || !result.flag) {
-            let name = folder.name.toLowerCase().trim();
+            let name = folder.name
+                .toLowerCase()
+                .replace(/\u200e/g, '')
+                .trim();
+
             result = {
                 flag: Object.keys(module.exports.names).find(flag => module.exports.names[flag].includes(name)),
                 source: 'name'

package/lib/types.d.ts

@@ -805,13 +805,13 @@ declare type SearchObject = {
 };
 
 /**
- * @property path - full mailbox path where the message was uploaded to
+ * @property destination - full mailbox path where the message was uploaded to
  * @property [uidValidity] - mailbox `UIDVALIDITY` if server has `UIDPLUS` extension enabled
  * @property [uid] - UID of the uploaded message if server has `UIDPLUS` extension enabled
  * @property [seq] - sequence number of the uploaded message if path is currently selected mailbox
  */
 declare type AppendResponseObject = {
-    path: string;
+    destination: string;
     uidValidity?: bigint;
     uid?: number;
     seq?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.143",
+    "version": "1.0.145",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -9,7 +9,8 @@
         "docs": "rm -rf docs && mkdir -p docs && jsdoc lib/imap-flow.js -c jsdoc.json -R README.md --destination docs/ && cp assets/favicon.ico docs",
         "dst": "node types.js",
         "build": "npm run docs && npm run dst",
-        "st": "npm run docs && st -d docs -i index.html"
+        "st": "npm run docs && st -d docs -i index.html",
+        "update": "rm -rf node_modules package-lock.json && ncu -u && npm install"
     },
     "repository": {
         "type": "git",
@@ -27,13 +28,13 @@
     },
     "homepage": "https://imapflow.com/",
     "devDependencies": {
-        "@babel/eslint-parser": "7.22.11",
+        "@babel/eslint-parser": "7.22.15",
         "@babel/eslint-plugin": "7.22.10",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.22.14",
-        "@types/node": "20.5.9",
+        "@babel/preset-env": "7.23.2",
+        "@types/node": "20.8.9",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.48.0",
+        "eslint": "8.52.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.0.0",
         "grunt": "1.6.1",
@@ -51,8 +52,8 @@
         "libmime": "5.2.1",
         "libqp": "2.0.1",
         "mailsplit": "5.4.0",
-        "nodemailer": "6.9.4",
-        "pino": "8.15.0",
+        "nodemailer": "6.9.7",
+        "pino": "8.16.1",
         "socks": "2.7.1"
     }
 }

package/test/imap-parser-test.js

@@ -977,3 +977,10 @@ module.exports['IMAP Parser, NO with a dot'] = test =>
         test.equal(parsed.command, 'NO');
         test.deepEqual(parsed.attributes, [{ type: 'TEXT', value: 'Server Unavailable. 15' }]);
     });
+
+module.exports['IMAP Parser, BAD with throttling'] = test =>
+    asyncWrapper(test, async test => {
+        let parsed = await parser('X BAD Request is throttled. Suggested Backoff Time: 92415 milliseconds');
+        test.equal(parsed.command, 'BAD');
+        test.deepEqual(parsed.attributes, [{ type: 'TEXT', value: 'Request is throttled. Suggested Backoff Time: 92415 milliseconds' }]);
+    });