imapflow 1.0.98 → 1.0.101

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+-   1.0.100 - 2022-06-17
+
+    -   Emit new message notification if appending to currently opened folder
+
+-   1.0.99 - 2022-06-05
+
+    -   Check if folder exists on failed status command
+
 -   1.0.98 - 2022-05-30
 
     -   Fixed an issue with envelope parsing where literal values were returned as Buffers

package/README.md

@@ -1,14 +1,16 @@
 # ImapFlow
 
+ImapFlow is a modern and easy-to-use IMAP client library for Node.js.
+
 ---
 
-> Managing IMAP connections is cool, but if you are only looking for an easy way to integrate email accounts, then ImapFlow was built for [EmailEngine Email API](https://emailengine.app/). It's a self-hosted software that converts all IMAP accounts to easy-to-use REST interfaces.
+> Managing an IMAP connection is cool, but if you are only looking for an easy way to integrate email accounts, then ImapFlow was built for [EmailEngine Email API](https://emailengine.app/). It's a self-hosted software that converts all IMAP accounts to easy-to-use REST interfaces.
 
 ---
 
 The focus for ImapFlow is to provide easy to use API over IMAP. Using ImapFlow does not expect knowledge about specific IMAP details. A general understanding is good enough.
 
-IMAP extensions are handled in the background, so for example, you can always request `labels` value from a {@link FetchQueryObject|fetch()} call, but if the IMAP server does not support `X-GM-EXT1` extension, then `labels` value is not included in the response.
+IMAP extensions are handled in the background, so, for example, you can always request `labels` value from a {@link FetchQueryObject|fetch()} call, but if the IMAP server does not support `X-GM-EXT1` extension, then `labels` value is not included in the response.
 
 ## Source
 

package/lib/commands/append.js

@@ -62,6 +62,18 @@ module.exports = async (connection, destination, content, flags, idate) => {
                 ? {
                       EXISTS: async untagged => {
                           map.seq = Number(untagged.command);
+
+                          if (expectExists) {
+                              let prevCount = connection.mailbox.exists;
+                              if (map.seq !== prevCount) {
+                                  connection.mailbox.exists = map.seq;
+                                  connection.emit('exists', {
+                                      path: connection.mailbox.path,
+                                      count: map.seq,
+                                      prevCount
+                                  });
+                              }
+                          }
                       }
                   }
                 : false
@@ -95,6 +107,18 @@ module.exports = async (connection, destination, content, flags, idate) => {
                     untagged: {
                         EXISTS: async untagged => {
                             map.seq = Number(untagged.command);
+
+                            if (expectExists) {
+                                let prevCount = connection.mailbox.exists;
+                                if (map.seq !== prevCount) {
+                                    connection.mailbox.exists = map.seq;
+                                    connection.emit('exists', {
+                                        path: connection.mailbox.path,
+                                        count: map.seq,
+                                        prevCount
+                                    });
+                                }
+                            }
                         }
                     },
                     comment: 'Sequence not found from APPEND output'

package/lib/commands/list.js

@@ -4,7 +4,9 @@ const { decodePath, encodePath, normalizePath } = require('../tools.js');
 const { specialUse } = require('../special-use');
 
 // Lists mailboxes from server
-module.exports = async (connection, reference, mailbox) => {
+module.exports = async (connection, reference, mailbox, options) => {
+    options = options || {};
+
     let listCommand = connection.capabilities.has('XLIST') && !connection.capabilities.has('SPECIAL-USE') ? 'XLIST' : 'LIST';
 
     let response;
@@ -64,6 +66,10 @@ module.exports = async (connection, reference, mailbox) => {
         let normalizedReference = normalizePath(connection, reference || '');
         await runList(normalizedReference, normalizePath(connection, mailbox || '', true));
 
+        if (options.listOnly) {
+            return entries;
+        }
+
         if (normalizedReference && !entries.find(entry => entry.specialUse === '\\Inbox')) {
             // INBOX was most probably not included in the listing if namespace was used
             await runList('', 'INBOX');

package/lib/commands/status.js

@@ -126,6 +126,16 @@ module.exports = async (connection, path, query) => {
         response.next();
         return map;
     } catch (err) {
+        if (err.responseStatus === 'NO') {
+            let folders = await connection.run('LIST', '', path, { listOnly: true });
+            if (folders && !folders.length) {
+                let error = new Error(`Mailbox doesn't exist: ${path}`);
+                error.code = 'NotFound';
+                error.response = err;
+                throw error;
+            }
+        }
+
         connection.log.warn({ err, cid: connection.id });
         return false;
     }

package/lib/imap-flow.js

@@ -121,7 +121,7 @@ class ImapFlow extends EventEmitter {
      * @param {Boolean} [options.disableAutoIdle=false] if `true` then IDLE is not started automatically. Useful if you only need to perform specific tasks over the connection
      * @param {Object} [options.tls] Additional TLS options (see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) for all available options)
      * @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] latest Node.js defaults to *'TLSv1.2'*, for older mail servers you might need to use something else, eg *'TLSv1'*
+     * @param {String} [options.tls.minVersion=TLSv1] 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 {Boolean} [options.logRaw=false] If true then log data read from and written to socket encoded in base64
@@ -731,7 +731,8 @@ class ImapFlow extends EventEmitter {
                     socket: this.socket,
                     servername: this.servername,
                     port: this.port,
-                    minVersion: 'TLSv1'
+                    minVersion: 'TLSv1',
+                    minDHSize: 1024
                 },
                 this.options.tls || {}
             );
@@ -1140,7 +1141,8 @@ class ImapFlow extends EventEmitter {
                 host: this.host,
                 servername: this.servername,
                 port: this.port,
-                minVersion: 'TLSv1'
+                minVersion: 'TLSv1',
+                minDHSize: 1024
             },
             this.options.tls || {}
         );
@@ -2501,6 +2503,17 @@ class ImapFlow extends EventEmitter {
                 this.currentLockId = lockId;
                 return resolve({ path, release });
             } catch (err) {
+                if (err.responseStatus === 'NO') {
+                    try {
+                        let folders = await this.run('LIST', '', path, { listOnly: true });
+                        if (!folders || !folders.length) {
+                            err.mailboxMissing = true;
+                        }
+                    } catch (E) {
+                        this.log.trace({ msg: 'Failed to verify failed mailbox', path, err: E });
+                    }
+                }
+
                 this.log.trace({ msg: 'Failed to acquire mailbox lock', path, lockId });
                 reject(err);
                 await this.processLocks(true);
@@ -2531,6 +2544,7 @@ class ImapFlow extends EventEmitter {
      */
     async getMailboxLock(path, options) {
         options = options || {};
+
         path = normalizePath(this, path);
 
         let lockId = ++this.lockCounter;

package/lib/search-compiler.js

@@ -120,6 +120,10 @@ module.exports.searchCompiler = (connection, query) => {
                 case 'GMRAW':
                     if (connection.capabilities.has('X-GM-EXT-1')) {
                         setOpt(attributes, 'X-GM-RAW', params[term]);
+                    } else {
+                        let error = new Error('Server does not support X-GM-EXT-1 extension required for X-GM-RAW');
+                        error.code = 'MissingServerExtension';
+                        throw error;
                     }
                     break;
 

package/lib/types.d.ts

@@ -20,7 +20,7 @@ declare module "imapflow" {
      * @param [options.disableAutoIdle = false] - if `true` then IDLE is not started automatically. Useful if you only need to perform specific tasks over the connection
      * @param [options.tls] - Additional TLS options (see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) for all available options)
      * @param [options.tls.rejectUnauthorized = true] - if `false` then client accepts self-signed and expired certificates from the server
-     * @param [options.tls.minVersion = TLSv1.2] - latest Node.js defaults to *'TLSv1.2'*, for older mail servers you might need to use something else, eg *'TLSv1'*
+     * @param [options.tls.minVersion = TLSv1] - 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.logRaw = false] - If true then log data read from and written to socket encoded in base64

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.98",
+    "version": "1.0.101",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -27,20 +27,20 @@
     },
     "homepage": "https://imapflow.com/",
     "devDependencies": {
-        "@babel/eslint-parser": "7.18.2",
-        "@babel/eslint-plugin": "7.17.7",
+        "@babel/eslint-parser": "7.18.9",
+        "@babel/eslint-plugin": "7.18.10",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.18.2",
-        "@types/node": "17.0.36",
+        "@babel/preset-env": "7.18.10",
+        "@types/node": "18.6.5",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.16.0",
+        "eslint": "8.21.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.5.0",
         "grunt": "1.5.3",
         "grunt-cli": "1.4.3",
         "grunt-contrib-nodeunit": "4.0.0",
         "grunt-eslint": "24.0.0",
-        "jsdoc": "3.6.10",
+        "jsdoc": "3.6.11",
         "st": "3.0.0",
         "tsd-jsdoc": "2.5.0"
     },
@@ -51,8 +51,8 @@
         "libmime": "5.1.0",
         "libqp": "1.1.0",
         "mailsplit": "5.3.2",
-        "nodemailer": "6.7.5",
-        "pino": "7.11.0",
-        "socks": "2.6.2"
+        "nodemailer": "6.7.7",
+        "pino": "8.4.0",
+        "socks": "2.7.0"
     }
 }