imapflow 1.0.89 → 1.0.92

package/lib/imap-flow.js

@@ -129,6 +129,8 @@ class ImapFlow extends EventEmitter {
      * @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`
+     * @param {Number} [options.maxIdleTime] If set, then breaks and restarts IDLE every maxIdleTime ms
+     * @param {Boolean} [options.disableBinary=false] If true, then ignores the BINARY extension when making FETCH and APPEND calls
      */
     constructor(options) {
         super({ captureRejections: true });
@@ -182,7 +184,8 @@ class ImapFlow extends EventEmitter {
         this.streamer = new ImapStream({
             logger: this.log,
             cid: this.id,
-            logRaw: this.logRaw
+            logRaw: this.logRaw,
+            secureConnection: this.secureConnection
         });
 
         this.reading = false;
@@ -260,6 +263,10 @@ class ImapFlow extends EventEmitter {
         this.currentLock = false;
         this.locks = [];
 
+        this.maxIdleTime = this.options.maxIdleTime || false;
+
+        this.disableBinary = !!this.options.disableBinary;
+
         this.streamer.on('error', err => {
             if (['Z_BUF_ERROR', 'ECONNRESET', 'EPIPE', 'ETIMEDOUT', 'EHOSTUNREACH'].includes(err.code)) {
                 // just close the connection, usually nothing but noise
@@ -307,7 +314,14 @@ class ImapFlow extends EventEmitter {
         }
 
         if (this.logRaw) {
-            this.log.trace({ src: 'c', msg: 'write to socket', data: chunk.toString('base64'), compress: !!this._deflate, cid: this.id });
+            this.log.trace({
+                src: 'c',
+                msg: 'write to socket',
+                data: chunk.toString('base64'),
+                compress: !!this._deflate,
+                secure: !!this.secureConnection,
+                cid: this.id
+            });
         }
 
         this.writeSocket.write(chunk);
@@ -747,13 +761,14 @@ class ImapFlow extends EventEmitter {
             this.upgrading = true;
             this.socket = tls.connect(opts, () => {
                 clearTimeout(this.upgradeTimeout);
-                if (this.closed) {
+                if (this.isClosed) {
                     // not sure if this is possible?
                     return this.close();
                 }
 
                 this.secureConnection = true;
                 this.upgrading = false;
+                this.streamer.secureConnection = true;
                 this.socket.pipe(this.streamer);
                 this.tls = typeof this.socket.getCipher === 'function' ? this.socket.getCipher() : false;
                 if (this.tls) {
@@ -835,7 +850,7 @@ class ImapFlow extends EventEmitter {
         this.untaggedHandlers.OK = null;
         this.untaggedHandlers.PREAUTH = null;
 
-        if (this.closed) {
+        if (this.isClosed) {
             return;
         }
 
@@ -868,7 +883,7 @@ class ImapFlow extends EventEmitter {
         this.untaggedHandlers.OK = null;
         this.untaggedHandlers.PREAUTH = null;
 
-        if (this.closed) {
+        if (this.isClosed) {
             return;
         }
 
@@ -1060,6 +1075,15 @@ class ImapFlow extends EventEmitter {
             range = range.toString();
         }
 
+        // special case, some servers allow this, some do not, so replace it with the last known EXISTS value
+        if (range === '*') {
+            if (!this.mailbox.exists) {
+                return false;
+            }
+            range = this.mailbox.exists.toString();
+            options.uid = false; // sequence query
+        }
+
         if (range && typeof range === 'object' && !Array.isArray(range)) {
             if (range.all && Object.keys(range) === 1) {
                 range = '1:*';
@@ -1269,7 +1293,9 @@ class ImapFlow extends EventEmitter {
             let reject = this.initialReject;
             this.initialResolve = false;
             this.initialReject = false;
-            reject(new Error('Unexpected close'));
+            let err = new Error('Unexpected close');
+            err.code = `ClosedAfterConnect${this.secureConnection ? 'TLS' : 'Text'}`;
+            reject(err);
         }
 
         if (typeof this.preCheck === 'function') {
@@ -1299,10 +1325,10 @@ class ImapFlow extends EventEmitter {
         }
 
         this.state = this.states.LOGOUT;
-        if (this.closed) {
+        if (this.isClosed) {
             return;
         }
-        this.closed = true;
+        this.isClosed = true;
 
         if (this.writeSocket && !this.writeSocket.destroyed) {
             try {
@@ -1354,9 +1380,12 @@ class ImapFlow extends EventEmitter {
     /**
      * @typedef {Object} ListResponse
      * @global
-     * @property {String} path mailbox path
+     * @property {String} path mailbox path (unicode string)
+     * @property {String} pathAsListed mailbox path as listed in the LIST/LSUB response
      * @property {String} name mailbox name (last part of path after delimiter)
      * @property {String} delimiter mailbox path delimiter, usually "." or "/"
+     * @property {Array<string>} parent An array of parent folder names. All names are in unicode
+     * @property {String} parentPath Same as `parent`, but as a complete string path (unicode string)
      * @property {Set<string>} flags a set of flags for this mailbox
      * @property {String} specialUse one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set
      * @property {Boolean} listed `true` if mailbox was found from the output of LIST command
@@ -1560,7 +1589,7 @@ class ImapFlow extends EventEmitter {
     /**
      * Requests the status of the indicated mailbox. Only requested status values will be returned.
      *
-     * @param {String} path mailbox path to check for
+     * @param {String} path mailbox path to check for (unicode string)
      * @param {Object} query defines requested status items
      * @param {Boolean} query.messages if `true` request count of messages
      * @param {Boolean} query.recent if `true` request count of messages with \\Recent tag
@@ -1593,7 +1622,7 @@ class ImapFlow extends EventEmitter {
      */
     async idle() {
         if (!this.idling) {
-            return await this.run('IDLE');
+            return await this.run('IDLE', this.maxIdleTime);
         }
     }
 
@@ -1783,7 +1812,7 @@ class ImapFlow extends EventEmitter {
     /**
      * Appends a new message to a mailbox
      *
-     * @param {String} path Mailbox path to upload the message to
+     * @param {String} path Mailbox path to upload the message to (unicode string)
      * @param {string|Buffer} content RFC822 formatted email message
      * @param {string[]} [flags] an array of flags to be set for the uploaded message
      * @param {Date|string} [idate=now] internal date to be set for the message
@@ -2093,6 +2122,14 @@ class ImapFlow extends EventEmitter {
             return;
         }
 
+        if (seq === '*') {
+            if (!this.mailbox.exists) {
+                return false;
+            }
+            seq = this.mailbox.exists.toString();
+            options = Object.assign({}, options || {}, { uid: false }); // force into a sequence query
+        }
+
         let response = await this.run('FETCH', (seq || '').toString(), query, options);
 
         if (!response || !response.list || !response.list.length) {

package/lib/tools.js

@@ -9,6 +9,30 @@ const { JPDecoder } = require('./jp-decoder');
 const iconv = require('iconv-lite');
 
 module.exports = {
+    encodePath(connection, path) {
+        path = (path || '').toString();
+        if (!connection.enabled.has('UTF8=ACCEPT') && /[&\x00-\x08\x0b-\x0c\x0e-\x1f\u0080-\uffff]/.test(path)) {
+            try {
+                path = iconv.encode(path, 'utf-7-imap').toString();
+            } catch (err) {
+                // ignore, keep name as is
+            }
+        }
+        return path;
+    },
+
+    decodePath(connection, path) {
+        path = (path || '').toString();
+        if (!connection.enabled.has('UTF8=ACCEPT') && /[&]/.test(path)) {
+            try {
+                path = iconv.decode(Buffer.from(path), 'utf-7-imap').toString();
+            } catch (err) {
+                // ignore, keep name as is
+            }
+        }
+        return path;
+    },
+
     normalizePath(connection, path, skipNamespace) {
         if (Array.isArray(path)) {
             path = path.join((connection.namespace && connection.namespace.delimiter) || '');
@@ -19,14 +43,6 @@ module.exports = {
             return 'INBOX';
         }
 
-        if (!connection.enabled.has('UTF8=ACCEPT') && /[\x00-\x08\x0b-\x0c\x0e-\x1f\u0080-\uffff]/.test(path)) {
-            try {
-                path = iconv.encode(path, 'utf-7-imap').toString();
-            } catch (err) {
-                // ignore, keep name as is
-            }
-        }
-
         // ensure namespace prefix if needed
         if (!skipNamespace && connection.namespace && connection.namespace.prefix && path.indexOf(connection.namespace.prefix) !== 0) {
             path = connection.namespace.prefix + path;
@@ -290,9 +306,10 @@ module.exports = {
                     break;
                 }
 
-                default:
-                    if (key.indexOf('body[') >= 0) {
-                        let partKey = key.replace(/^body\[|]$/g, '');
+                default: {
+                    let match = key.match(/(body|binary)\[/i);
+                    if (match) {
+                        let partKey = key.replace(/^(body|binary)\[|]$/gi, '');
                         partKey = partKey.replace(/\.fields.*$/g, '');
 
                         let value = getBuffer(attribute);
@@ -308,6 +325,7 @@ module.exports = {
                         break;
                     }
                     break;
+                }
             }
         }
 

package/lib/types.d.ts

@@ -28,6 +28,8 @@ declare module "imapflow" {
      * @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`
+     * @param [options.maxIdleTime] - If set, then breaks and restarts IDLE every maxIdleTime ms
+     * @param [options.disableBinary = false] - If true, then ignores the BINARY extension when making FETCH and APPEND calls
      */
     class ImapFlow extends EventEmitter {
         constructor(options: {
@@ -54,6 +56,8 @@ declare module "imapflow" {
             verifyOnly?: boolean;
             proxy?: boolean;
             qresync?: boolean;
+            maxIdleTime?: number;
+            disableBinary?: boolean;
         });
         /**
          * Current module version as a static class property
@@ -239,7 +243,7 @@ declare module "imapflow" {
          * let status = await client.status('INBOX', {unseen: true});
          * console.log(status.unseen);
          * // 123
-         * @param path - mailbox path to check for
+         * @param path - mailbox path to check for (unicode string)
          * @param query - defines requested status items
          * @param query.messages - if `true` request count of messages
          * @param query.recent - if `true` request count of messages with \\Recent tag
@@ -340,7 +344,7 @@ declare module "imapflow" {
          * Appends a new message to a mailbox
          * @example
          * await client.append('INBOX', rawMessageBuffer, ['\\Seen'], new Date(2000, 1, 1));
-         * @param path - Mailbox path to upload the message to
+         * @param path - Mailbox path to upload the message to (unicode string)
          * @param content - RFC822 formatted email message
          * @param [flags] - an array of flags to be set for the uploaded message
          * @param [idate = now] - internal date to be set for the message
@@ -563,9 +567,12 @@ declare type QuotaResponse = {
 };
 
 /**
- * @property path - mailbox path
+ * @property path - mailbox path (unicode string)
+ * @property pathAsListed - mailbox path as listed in the LIST/LSUB response
  * @property name - mailbox name (last part of path after delimiter)
  * @property delimiter - mailbox path delimiter, usually "." or "/"
+ * @property parent - An array of parent folder names. All names are in unicode
+ * @property parentPath - Same as `parent`, but as a complete string path (unicode string)
  * @property flags - a set of flags for this mailbox
  * @property specialUse - one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set
  * @property listed - `true` if mailbox was found from the output of LIST command
@@ -573,8 +580,11 @@ declare type QuotaResponse = {
  */
 declare type ListResponse = {
     path: string;
+    pathAsListed: string;
     name: string;
     delimiter: string;
+    parent: string[];
+    parentPath: string;
     flags: Set<string>;
     specialUse: string;
     listed: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.89",
+    "version": "1.0.92",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -8,7 +8,8 @@
         "prepare": "npm run build",
         "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"
+        "build": "npm run docs && npm run dst",
+        "st": "npm run docs && st -d docs -i index.html"
     },
     "repository": {
         "type": "git",
@@ -29,28 +30,29 @@
         "@babel/eslint-parser": "7.17.0",
         "@babel/eslint-plugin": "7.17.7",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.16.11",
-        "@types/node": "17.0.23",
+        "@babel/preset-env": "7.17.10",
+        "@types/node": "17.0.31",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.12.0",
+        "eslint": "8.14.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.5.0",
-        "grunt": "1.4.1",
+        "grunt": "1.5.2",
         "grunt-cli": "1.4.3",
         "grunt-contrib-nodeunit": "4.0.0",
         "grunt-eslint": "24.0.0",
         "jsdoc": "3.6.10",
+        "st": "3.0.0",
         "tsd-jsdoc": "2.5.0"
     },
     "dependencies": {
         "encoding-japanese": "2.0.0",
         "iconv-lite": "0.6.3",
         "libbase64": "1.2.1",
-        "libmime": "5.0.0",
+        "libmime": "5.1.0",
         "libqp": "1.1.0",
-        "mailsplit": "5.3.1",
-        "nodemailer": "6.7.3",
-        "pino": "7.9.2",
+        "mailsplit": "5.3.2",
+        "nodemailer": "6.7.4",
+        "pino": "7.11.0",
         "socks": "2.6.2"
     }
 }

package/test/imap-compiler-test.js

@@ -200,8 +200,7 @@ module.exports['IMAP Compiler: hide long strings'] = test =>
                     attributes: [
                         {
                             type: 'String',
-                            value:
-                                'Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere!'
+                            value: 'Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere! Tere tere!'
                         },
                         'Vana kere'
                     ]
@@ -248,6 +247,46 @@ module.exports['IMAP Compiler: LITERAL text'] = test =>
         )
     );
 
+module.exports['IMAP Compiler: LITERAL literal'] = test =>
+    asyncWrapper(test, async test =>
+        test.equal(
+            await compiler({
+                tag: '*',
+                command: 'CMD',
+                attributes: [
+                    // keep indentation
+                    {
+                        type: 'LITERAL',
+                        value: 'Tere\x00 tere!',
+                        isLiteral8: false
+                    },
+                    'Vana kere'
+                ]
+            }),
+            '* CMD {11}\r\nTere\x00 tere! "Vana kere"'
+        )
+    );
+
+module.exports['IMAP Compiler: LITERAL literal8'] = test =>
+    asyncWrapper(test, async test =>
+        test.equal(
+            await compiler({
+                tag: '*',
+                command: 'CMD',
+                attributes: [
+                    // keep indentation
+                    {
+                        type: 'LITERAL',
+                        value: 'Tere\x00 tere!',
+                        isLiteral8: true
+                    },
+                    'Vana kere'
+                ]
+            }),
+            '* CMD ~{11}\r\nTere\x00 tere! "Vana kere"'
+        )
+    );
+
 module.exports['IMAP Compiler: LITERAL array 1'] = test =>
     asyncWrapper(test, async test =>
         test.deepEqual(

package/test/imap-parser-test.js

@@ -309,6 +309,36 @@ module.exports['IMAP Parser: Literals: single literal'] = test =>
         ])
     );
 
+module.exports['IMAP Parser: Literals: literal with NULL'] = test =>
+    asyncWrapper(test, async test =>
+        test.deepEqual((await parser('TAG1 CMD {4}\r\n', { literals: [Buffer.from('ab\x00d')] })).attributes, [
+            {
+                type: 'LITERAL',
+                value: Buffer.from('ab\x00d')
+            }
+        ])
+    );
+
+module.exports['IMAP Parser: Literals: literal8'] = test =>
+    asyncWrapper(test, async test =>
+        test.deepEqual((await parser('TAG1 CMD ~{4}\r\n', { literals: [Buffer.from('ab\x00d')] })).attributes, [
+            {
+                type: 'LITERAL',
+                value: Buffer.from('ab\x00d')
+            }
+        ])
+    );
+
+module.exports['IMAP Parser: Literals: unexpected literal8 prefix'] = test =>
+    asyncWrapper(test, async test => {
+        try {
+            await parser('TAG1 CMD ~\r\n');
+            test.ok(false, 'Must throw');
+        } catch (err) {
+            test.ok(err, 'Error must exist');
+        }
+    });
+
 module.exports['IMAP Parser: Literals: multiple literals'] = test =>
     asyncWrapper(test, async test =>
         test.deepEqual((await parser('TAG1 CMD {4}\r\n {4}\r\n', { literals: [Buffer.from('abcd'), Buffer.from('kere')] })).attributes, [