imapflow 1.0.90 → 1.0.93

package/lib/handler/imap-formal-syntax.js

@@ -26,7 +26,7 @@ function excludeChars(source, exclude) {
 module.exports = {
     CHAR() {
         let value = expandRange(0x01, 0x7f);
-        this.CHAR = function() {
+        this.CHAR = function () {
             return value;
         };
         return value;
@@ -34,7 +34,7 @@ module.exports = {
 
     CHAR8() {
         let value = expandRange(0x01, 0xff);
-        this.CHAR8 = function() {
+        this.CHAR8 = function () {
             return value;
         };
         return value;
@@ -46,7 +46,7 @@ module.exports = {
 
     CTL() {
         let value = expandRange(0x00, 0x1f) + '\x7F';
-        this.CTL = function() {
+        this.CTL = function () {
             return value;
         };
         return value;
@@ -58,7 +58,7 @@ module.exports = {
 
     ALPHA() {
         let value = expandRange(0x41, 0x5a) + expandRange(0x61, 0x7a);
-        this.ALPHA = function() {
+        this.ALPHA = function () {
             return value;
         };
         return value;
@@ -66,7 +66,7 @@ module.exports = {
 
     DIGIT() {
         let value = expandRange(0x30, 0x39) + expandRange(0x61, 0x7a);
-        this.DIGIT = function() {
+        this.DIGIT = function () {
             return value;
         };
         return value;
@@ -74,7 +74,7 @@ module.exports = {
 
     'ATOM-CHAR'() {
         let value = excludeChars(this.CHAR(), this['atom-specials']());
-        this['ATOM-CHAR'] = function() {
+        this['ATOM-CHAR'] = function () {
             return value;
         };
         return value;
@@ -82,7 +82,7 @@ module.exports = {
 
     'ASTRING-CHAR'() {
         let value = this['ATOM-CHAR']() + this['resp-specials']();
-        this['ASTRING-CHAR'] = function() {
+        this['ASTRING-CHAR'] = function () {
             return value;
         };
         return value;
@@ -90,7 +90,7 @@ module.exports = {
 
     'TEXT-CHAR'() {
         let value = excludeChars(this.CHAR(), '\r\n');
-        this['TEXT-CHAR'] = function() {
+        this['TEXT-CHAR'] = function () {
             return value;
         };
         return value;
@@ -98,7 +98,7 @@ module.exports = {
 
     'atom-specials'() {
         let value = '(' + ')' + '{' + this.SP() + this.CTL() + this['list-wildcards']() + this['quoted-specials']() + this['resp-specials']();
-        this['atom-specials'] = function() {
+        this['atom-specials'] = function () {
             return value;
         };
         return value;
@@ -109,8 +109,8 @@ module.exports = {
     },
 
     'quoted-specials'() {
-        let value = this.DQUOTE() + '\\';
-        this['quoted-specials'] = function() {
+        let value = this.DQUOTE() + "'\\";
+        this['quoted-specials'] = function () {
             return value;
         };
         return value;
@@ -122,7 +122,7 @@ module.exports = {
 
     tag() {
         let value = excludeChars(this['ASTRING-CHAR'](), '+');
-        this.tag = function() {
+        this.tag = function () {
             return value;
         };
         return value;
@@ -130,7 +130,7 @@ module.exports = {
 
     command() {
         let value = this.ALPHA() + this.DIGIT() + '-';
-        this.command = function() {
+        this.command = function () {
             return value;
         };
         return value;

package/lib/handler/imap-stream.js

@@ -40,6 +40,7 @@ class ImapStream extends Transform {
         this.literals = [];
 
         this.compress = false;
+        this.secureConnection = this.options.secureConnection;
 
         this.processingInput = false;
         this.inputQueue = []; // unprocessed input chunks
@@ -197,7 +198,14 @@ class ImapStream extends Transform {
         }
 
         if (this.options.logRaw) {
-            this.log.trace({ src: 's', msg: 'read from socket', data: chunk.toString('base64'), compress: !!this.compress, cid: this.cid });
+            this.log.trace({
+                src: 's',
+                msg: 'read from socket',
+                data: chunk.toString('base64'),
+                compress: !!this.compress,
+                secure: !!this.secureConnection,
+                cid: this.cid
+            });
         }
 
         if (chunk && chunk.length) {

package/lib/handler/token-parser.js

@@ -29,13 +29,13 @@ class TokenParser {
             let elm;
             let partial;
 
-            if (!node.closed && node.type === 'SEQUENCE' && node.value === '*') {
-                node.closed = true;
+            if (!node.isClosed && node.type === 'SEQUENCE' && node.value === '*') {
+                node.isClosed = true;
                 node.type = 'ATOM';
             }
 
             // If the node was never closed, throw it
-            if (!node.closed) {
+            if (!node.isClosed) {
                 throw new Error('Unexpected end of input at position ' + (this.pos + this.str.length - 1));
             }
 
@@ -97,7 +97,7 @@ class TokenParser {
             childNodes: [],
             type: false,
             value: '',
-            closed: true
+            isClosed: true
         };
 
         if (parentNode) {
@@ -136,14 +136,14 @@ class TokenParser {
                             this.currentNode = this.createNode(this.currentNode, this.pos + i);
                             this.currentNode.type = 'string';
                             this.state = 'STRING';
-                            this.currentNode.closed = false;
+                            this.currentNode.isClosed = false;
                             break;
 
                         // ( starts a new list
                         case '(':
                             this.currentNode = this.createNode(this.currentNode, this.pos + i);
                             this.currentNode.type = 'LIST';
-                            this.currentNode.closed = false;
+                            this.currentNode.isClosed = false;
                             break;
 
                         // ) closes a list
@@ -152,7 +152,7 @@ class TokenParser {
                                 throw new Error('Unexpected list terminator ) at position ' + (this.pos + i));
                             }
 
-                            this.currentNode.closed = true;
+                            this.currentNode.isClosed = true;
                             this.currentNode.endPos = this.pos + i;
                             this.currentNode = this.currentNode.parentNode;
 
@@ -164,7 +164,7 @@ class TokenParser {
                             if (this.currentNode.type !== 'SECTION') {
                                 throw new Error('Unexpected section terminator ] at position ' + (this.pos + i));
                             }
-                            this.currentNode.closed = true;
+                            this.currentNode.isClosed = true;
                             this.currentNode.endPos = this.pos + i;
                             this.currentNode = this.currentNode.parentNode;
                             checkSP();
@@ -181,24 +181,36 @@ class TokenParser {
                                 this.currentNode = this.createNode(this.currentNode, this.pos + i);
                                 this.currentNode.type = 'PARTIAL';
                                 this.state = 'PARTIAL';
-                                this.currentNode.closed = false;
+                                this.currentNode.isClosed = false;
                             }
                             break;
 
+                        // binary literal8
+                        case '~': {
+                            let nextChr = this.str.charAt(i + 1);
+                            if (nextChr !== '{') {
+                                throw new Error('Unexpected literal8 marker at position ' + (this.pos + i));
+                            }
+                            this.expectedLiteralType = 'literal8';
+                            break;
+                        }
+
                         // { starts a new literal
                         case '{':
                             this.currentNode = this.createNode(this.currentNode, this.pos + i);
                             this.currentNode.type = 'LITERAL';
+                            this.currentNode.literalType = this.expectedLiteralType || 'literal';
+                            this.expectedLiteralType = false;
                             this.state = 'LITERAL';
-                            this.currentNode.closed = false;
+                            this.currentNode.isClosed = false;
                             break;
 
-                        // ( starts a new sequence
+                        // * starts a new sequence
                         case '*':
                             this.currentNode = this.createNode(this.currentNode, this.pos + i);
                             this.currentNode.type = 'SEQUENCE';
                             this.currentNode.value = chr;
-                            this.currentNode.closed = false;
+                            this.currentNode.isClosed = false;
                             this.state = 'SEQUENCE';
                             break;
 
@@ -218,7 +230,7 @@ class TokenParser {
 
                                 this.currentNode = this.createNode(this.currentNode, this.pos + i);
                                 this.currentNode.type = 'SECTION';
-                                this.currentNode.closed = false;
+                                this.currentNode.isClosed = false;
                                 this.state = 'NORMAL';
 
                                 // RFC2221 defines a response code REFERRAL whose payload is an
@@ -244,7 +256,7 @@ class TokenParser {
                                     this.currentNode = this.currentNode.parentNode;
 
                                     // close out the SECTION
-                                    this.currentNode.closed = true;
+                                    this.currentNode.isClosed = true;
                                     this.currentNode = this.currentNode.parentNode;
                                     checkSP();
                                 }
@@ -286,7 +298,7 @@ class TokenParser {
                         this.currentNode.endPos = this.pos + i - 1;
                         this.currentNode = this.currentNode.parentNode;
 
-                        this.currentNode.closed = true;
+                        this.currentNode.isClosed = true;
                         this.currentNode.endPos = this.pos + i;
                         this.currentNode = this.currentNode.parentNode;
                         this.state = 'NORMAL';
@@ -297,20 +309,20 @@ class TokenParser {
 
                     if ((chr === ',' || chr === ':') && this.currentNode.value.match(/^\d+$/)) {
                         this.currentNode.type = 'SEQUENCE';
-                        this.currentNode.closed = true;
+                        this.currentNode.isClosed = true;
                         this.state = 'SEQUENCE';
                     }
 
                     // [ starts a section group for this element
                     if (chr === '[') {
                         // allowed only for selected elements
-                        if (['BODY', 'BODY.PEEK'].indexOf(this.currentNode.value.toUpperCase()) < 0) {
+                        if (['BODY', 'BODY.PEEK', 'BINARY', 'BINARY.PEEK'].indexOf(this.currentNode.value.toUpperCase()) < 0) {
                             throw new Error('Unexpected section start char [ at position ' + this.pos);
                         }
                         this.currentNode.endPos = this.pos + i;
                         this.currentNode = this.createNode(this.currentNode.parentNode, this.pos + i);
                         this.currentNode.type = 'SECTION';
-                        this.currentNode.closed = false;
+                        this.currentNode.isClosed = false;
                         this.state = 'NORMAL';
                         break;
                     }
@@ -333,7 +345,7 @@ class TokenParser {
                     // DQUOTE ends the string sequence
                     if (chr === '"') {
                         this.currentNode.endPos = this.pos + i;
-                        this.currentNode.closed = true;
+                        this.currentNode.isClosed = true;
                         this.currentNode = this.currentNode.parentNode;
                         this.state = 'NORMAL';
 
@@ -359,7 +371,7 @@ class TokenParser {
                             throw new Error('Unexpected end of partial at position ' + this.pos);
                         }
                         this.currentNode.endPos = this.pos + i;
-                        this.currentNode.closed = true;
+                        this.currentNode.isClosed = true;
                         this.currentNode = this.currentNode.parentNode;
                         this.state = 'NORMAL';
                         checkSP();
@@ -385,16 +397,19 @@ class TokenParser {
                     if (this.currentNode.started) {
                         // only relevant if literals are not already parsed out from input
 
-                        //if(imapFormalSyntax['CHAR8']().indexOf(chr) < 0){
+                        // Disabled NULL byte check
+                        // See https://github.com/emailjs/emailjs-imap-handler/commit/f11b2822bedabe492236e8263afc630134a3c41c
+                        /*
                         if (chr === '\u0000') {
                             throw new Error('Unexpected \\x00 at position ' + (this.pos + i));
                         }
+                        */
 
                         this.currentNode.chBuffer[this.currentNode.chPos++] = chr.charCodeAt(0);
 
                         if (this.currentNode.chPos >= this.currentNode.literalLength) {
                             this.currentNode.endPos = this.pos + i;
-                            this.currentNode.closed = true;
+                            this.currentNode.isClosed = true;
                             this.currentNode.value = this.currentNode.chBuffer.toString('binary');
                             this.currentNode.chBuffer = Buffer.alloc(0);
                             this.currentNode = this.currentNode.parentNode;
@@ -427,7 +442,7 @@ class TokenParser {
                             // special case where literal content length is 0
                             // close the node right away, do not wait for additional input
                             this.currentNode.endPos = this.pos + i;
-                            this.currentNode.closed = true;
+                            this.currentNode.isClosed = true;
                             this.currentNode = this.currentNode.parentNode;
                             this.state = 'NORMAL';
                             checkSP();
@@ -445,7 +460,7 @@ class TokenParser {
                             this.currentNode.endPos = this.pos + i + this.currentNode.value.length;
 
                             this.currentNode.started = false;
-                            this.currentNode.closed = true;
+                            this.currentNode.isClosed = true;
                             this.currentNode = this.currentNode.parentNode;
                             this.state = 'NORMAL';
                             checkSP();
@@ -478,7 +493,7 @@ class TokenParser {
                             throw new Error('Unexpected whitespace at position ' + (this.pos + i));
                         }
 
-                        this.currentNode.closed = true;
+                        this.currentNode.isClosed = true;
                         this.currentNode.endPos = this.pos + i - 1;
                         this.currentNode = this.currentNode.parentNode;
                         this.state = 'NORMAL';
@@ -487,7 +502,7 @@ class TokenParser {
                         this.currentNode.endPos = this.pos + i - 1;
                         this.currentNode = this.currentNode.parentNode;
 
-                        this.currentNode.closed = true;
+                        this.currentNode.isClosed = true;
                         this.currentNode.endPos = this.pos + i;
                         this.currentNode = this.currentNode.parentNode;
                         this.state = 'NORMAL';

package/lib/imap-flow.js

@@ -130,6 +130,7 @@ class ImapFlow extends EventEmitter {
      * @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 });
@@ -183,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;
@@ -261,7 +263,9 @@ class ImapFlow extends EventEmitter {
         this.currentLock = false;
         this.locks = [];
 
-        this.maxIdleTime = options.maxIdleTime || false;
+        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)) {
@@ -310,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);
@@ -750,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) {
@@ -838,7 +850,7 @@ class ImapFlow extends EventEmitter {
         this.untaggedHandlers.OK = null;
         this.untaggedHandlers.PREAUTH = null;
 
-        if (this.closed) {
+        if (this.isClosed) {
             return;
         }
 
@@ -871,7 +883,7 @@ class ImapFlow extends EventEmitter {
         this.untaggedHandlers.OK = null;
         this.untaggedHandlers.PREAUTH = null;
 
-        if (this.closed) {
+        if (this.isClosed) {
             return;
         }
 
@@ -1063,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:*';
@@ -1272,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') {
@@ -1302,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 {
@@ -1357,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
@@ -1563,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
@@ -1786,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
@@ -2096,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

@@ -29,6 +29,7 @@ declare module "imapflow" {
      * @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: {
@@ -56,6 +57,7 @@ declare module "imapflow" {
             proxy?: boolean;
             qresync?: boolean;
             maxIdleTime?: number;
+            disableBinary?: boolean;
         });
         /**
          * Current module version as a static class property
@@ -241,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
@@ -342,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
@@ -565,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
@@ -575,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;