imapflow 1.0.160 → 1.0.161

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.0.161](https://github.com/postalsys/imapflow/compare/v1.0.160...v1.0.161) (2024-05-06)
+
+
+### Bug Fixes
+
+* **listTree:** pass listing options as an optional argument ([917ba80](https://github.com/postalsys/imapflow/commit/917ba80f21b2fe485154acd252d6565b838e73e6))
+
 ## [1.0.160](https://github.com/postalsys/imapflow/compare/v1.0.159...v1.0.160) (2024-04-22)
 
 

package/lib/imap-flow.js

@@ -768,7 +768,7 @@ class ImapFlow extends EventEmitter {
         this.writeSocket.destroySoon = () => {
             try {
                 if (this.socket) {
-                    if (typeof this.socket.destroySoon === "function") {
+                    if (typeof this.socket.destroySoon === 'function') {
                         this.socket.destroySoon();
                     } else {
                         this.socket.destroy();
@@ -1484,7 +1484,7 @@ class ImapFlow extends EventEmitter {
 
         if (this.writeSocket && !this.writeSocket.destroyed) {
             try {
-                if (typeof this.writeSocket.destroySoon === "function") {
+                if (typeof this.writeSocket.destroySoon === 'function') {
                     this.writeSocket.destroySoon();
                 } else {
                     this.writeSocket.destroy();
@@ -1496,7 +1496,7 @@ class ImapFlow extends EventEmitter {
 
         if (this.socket && !this.socket.destroyed && this.writeSocket !== this.socket) {
             try {
-                if (typeof this.socket.destroySoon === "function") {
+                if (typeof this.socket.destroySoon === 'function') {
                     this.socket.destroySoon();
                 } else {
                     this.socket.destroy();
@@ -1544,7 +1544,7 @@ class ImapFlow extends EventEmitter {
      * @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[]} 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
@@ -1553,22 +1553,27 @@ class ImapFlow extends EventEmitter {
      * @property {StatusObject} [status] If `statusQuery` was used, then this value includes the status response
      */
 
+    /**
+     * @typedef {Object} ListOptions
+     * @global
+     * @property {Object} [statusQuery] request status items for every listed entry
+     * @property {Boolean} [statusQuery.messages] if `true` request count of messages
+     * @property {Boolean} [statusQuery.recent] if `true` request count of messages with \\Recent tag
+     * @property {Boolean} [statusQuery.uidNext] if `true` request predicted next UID
+     * @property {Boolean} [statusQuery.uidValidity] if `true` request mailbox `UIDVALIDITY` value
+     * @property {Boolean} [statusQuery.unseen] if `true` request count of unseen messages
+     * @property {Boolean} [statusQuery.highestModseq] if `true` request last known modseq value
+     * @property {Object} [specialUseHints] set specific paths as special use folders, this would override special use flags provided from the server
+     * @property {String} [specialUseHints.sent] Path to "Sent Mail" folder
+     * @property {String} [specialUseHints.trash] Path to "Trash" folder
+     * @property {String} [specialUseHints.junk] Path to "Junk Mail" folder
+     * @property {String} [specialUseHints.drafts] Path to "Drafts" folder
+     */
+
     /**
      * Lists available mailboxes as an Array
      *
-     * @param {Object} [options] defines additional listing options
-     * @param {Object} [options.statusQuery] request status items for every listed entry
-     * @param {Boolean} [options.statusQuery.messages] if `true` request count of messages
-     * @param {Boolean} [options.statusQuery.recent] if `true` request count of messages with \\Recent tag
-     * @param {Boolean} [options.statusQuery.uidNext] if `true` request predicted next UID
-     * @param {Boolean} [options.statusQuery.uidValidity] if `true` request mailbox `UIDVALIDITY` value
-     * @param {Boolean} [options.statusQuery.unseen] if `true` request count of unseen messages
-     * @param {Boolean} [options.statusQuery.highestModseq] if `true` request last known modseq value
-     * @param {Object} [options.specialUseHints] set specific paths as special use folders, this would override special use flags provided from the server
-     * @param {String} [options.specialUseHints.sent] Path to "Sent Mail" folder
-     * @param {String} [options.specialUseHints.trash] Path to "Trash" folder
-     * @param {String} [options.specialUseHints.junk] Path to "Junk Mail" folder
-     * @param {String} [options.specialUseHints.drafts] Path to "Drafts" folder
+     * @param {ListOptions} [options] defines additional listing options
      * @returns {Promise<ListResponse[]>} An array of ListResponse objects
      *
      * @example
@@ -1589,7 +1594,7 @@ class ImapFlow extends EventEmitter {
      * @property {String} path mailbox path
      * @property {String} name mailbox name (last part of path after delimiter)
      * @property {String} delimiter mailbox path delimiter, usually "." or "/"
-     * @property {array} flags list of flags for this mailbox
+     * @property {String[]} flags list 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
      * @property {Boolean} subscribed `true` if mailbox was found from the output of LSUB command
@@ -1600,14 +1605,16 @@ class ImapFlow extends EventEmitter {
     /**
      * Lists available mailboxes as a tree structured object
      *
+     * @param {ListOptions} [options] defines additional listing options
      * @returns {Promise<ListTreeResponse>} Tree structured object
      *
      * @example
      * let tree = await client.listTree();
      * tree.folders.forEach(mailbox=>console.log(mailbox.path));
      */
-    async listTree() {
-        let folders = await this.run('LIST', '', '*');
+    async listTree(options) {
+        options = options || {};
+        let folders = await this.run('LIST', '', '*', options);
         this.folders = new Map(folders.map(folder => [folder.path, folder]));
         return getFolderTree(folders);
     }

package/lib/types.d.ts

@@ -162,44 +162,18 @@ declare module "imapflow" {
          * let list = await client.list();
          * list.forEach(mailbox=>console.log(mailbox.path));
          * @param [options] - defines additional listing options
-         * @param [options.statusQuery] - request status items for every listed entry
-         * @param [options.statusQuery.messages] - if `true` request count of messages
-         * @param [options.statusQuery.recent] - if `true` request count of messages with \\Recent tag
-         * @param [options.statusQuery.uidNext] - if `true` request predicted next UID
-         * @param [options.statusQuery.uidValidity] - if `true` request mailbox `UIDVALIDITY` value
-         * @param [options.statusQuery.unseen] - if `true` request count of unseen messages
-         * @param [options.statusQuery.highestModseq] - if `true` request last known modseq value
-         * @param [options.specialUseHints] - set specific paths as special use folders, this would override special use flags provided from the server
-         * @param [options.specialUseHints.sent] - Path to "Sent Mail" folder
-         * @param [options.specialUseHints.trash] - Path to "Trash" folder
-         * @param [options.specialUseHints.junk] - Path to "Junk Mail" folder
-         * @param [options.specialUseHints.drafts] - Path to "Drafts" folder
          * @returns An array of ListResponse objects
          */
-        list(options?: {
-            statusQuery?: {
-                messages?: boolean;
-                recent?: boolean;
-                uidNext?: boolean;
-                uidValidity?: boolean;
-                unseen?: boolean;
-                highestModseq?: boolean;
-            };
-            specialUseHints?: {
-                sent?: string;
-                trash?: string;
-                junk?: string;
-                drafts?: string;
-            };
-        }): Promise<ListResponse[]>;
+        list(options?: ListOptions): Promise<ListResponse[]>;
         /**
          * Lists available mailboxes as a tree structured object
          * @example
          * let tree = await client.listTree();
          * tree.folders.forEach(mailbox=>console.log(mailbox.path));
+         * @param [options] - defines additional listing options
          * @returns Tree structured object
          */
-        listTree(): Promise<ListTreeResponse>;
+        listTree(options?: ListOptions): Promise<ListTreeResponse>;
         /**
          * Performs a no-op call against server
          */
@@ -660,7 +634,7 @@ declare type ListResponse = {
     pathAsListed: string;
     name: string;
     delimiter: string;
-    parent: string[];
+    parent: String[];
     parentPath: string;
     flags: Set<string>;
     specialUse: string;
@@ -669,6 +643,37 @@ declare type ListResponse = {
     status?: StatusObject;
 };
 
+/**
+ * @property [statusQuery] - request status items for every listed entry
+ * @property [statusQuery.messages] - if `true` request count of messages
+ * @property [statusQuery.recent] - if `true` request count of messages with \\Recent tag
+ * @property [statusQuery.uidNext] - if `true` request predicted next UID
+ * @property [statusQuery.uidValidity] - if `true` request mailbox `UIDVALIDITY` value
+ * @property [statusQuery.unseen] - if `true` request count of unseen messages
+ * @property [statusQuery.highestModseq] - if `true` request last known modseq value
+ * @property [specialUseHints] - set specific paths as special use folders, this would override special use flags provided from the server
+ * @property [specialUseHints.sent] - Path to "Sent Mail" folder
+ * @property [specialUseHints.trash] - Path to "Trash" folder
+ * @property [specialUseHints.junk] - Path to "Junk Mail" folder
+ * @property [specialUseHints.drafts] - Path to "Drafts" folder
+ */
+declare type ListOptions = {
+    statusQuery?: {
+        messages?: boolean;
+        recent?: boolean;
+        uidNext?: boolean;
+        uidValidity?: boolean;
+        unseen?: boolean;
+        highestModseq?: boolean;
+    };
+    specialUseHints?: {
+        sent?: string;
+        trash?: string;
+        junk?: string;
+        drafts?: string;
+    };
+};
+
 /**
  * @property root - If `true` then this is root node without any additional properties besides *folders*
  * @property path - mailbox path
@@ -686,7 +691,7 @@ declare type ListTreeResponse = {
     path: string;
     name: string;
     delimiter: string;
-    flags: any[];
+    flags: String[];
     specialUse: string;
     listed: boolean;
     subscribed: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.160",
+    "version": "1.0.161",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -28,11 +28,11 @@
     },
     "homepage": "https://imapflow.com/",
     "devDependencies": {
-        "@babel/eslint-parser": "7.24.1",
-        "@babel/eslint-plugin": "7.23.5",
+        "@babel/eslint-parser": "7.24.5",
+        "@babel/eslint-plugin": "7.24.5",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.24.4",
-        "@types/node": "20.12.7",
+        "@babel/preset-env": "7.24.5",
+        "@types/node": "20.12.8",
         "eslint": "8.57.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.1.0",
@@ -53,7 +53,7 @@
         "libqp": "2.1.0",
         "mailsplit": "5.4.0",
         "nodemailer": "6.9.13",
-        "pino": "8.20.0",
+        "pino": "9.0.0",
         "socks": "2.8.3"
     }
 }