imapflow 1.0.171 → 1.0.172

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.0.172](https://github.com/postalsys/imapflow/compare/v1.0.171...v1.0.172) (2025-01-03)
+
+
+### Bug Fixes
+
+* **password-auth:** Added option auth.loginMethod to set specific authentication method ('LOGIN', 'AUTH=PLAIN', 'AUTH=LOGIN') ([ce3c339](https://github.com/postalsys/imapflow/commit/ce3c33908f5ad445b1a2fdcf2dfcbd4859413cf7))
+
 ## [1.0.171](https://github.com/postalsys/imapflow/compare/v1.0.170...v1.0.171) (2024-12-05)
 
 

package/lib/commands/authenticate.js

@@ -137,7 +137,7 @@ async function authPlain(connection, username, password) {
 }
 
 // Authenticates user using LOGIN
-module.exports = async (connection, username, { accessToken, password }) => {
+module.exports = async (connection, username, { accessToken, password, loginMethod }) => {
     if (connection.state !== connection.states.NOT_AUTHENTICATED) {
         // nothing to do here
         return;
@@ -151,10 +151,11 @@ module.exports = async (connection, username, { accessToken, password }) => {
     }
 
     if (password) {
-        if (connection.capabilities.has('AUTH=PLAIN')) {
+        if ((!loginMethod && connection.capabilities.has('AUTH=PLAIN')) || loginMethod === 'AUTH=PLAIN') {
             return await authPlain(connection, username, password);
         }
-        if (connection.capabilities.has('AUTH=LOGIN')) {
+
+        if ((!loginMethod && connection.capabilities.has('AUTH=LOGIN')) || loginMethod === 'AUTH=LOGIN') {
             return await authLogin(connection, username, password);
         }
     }

package/lib/imap-flow.js

@@ -116,48 +116,110 @@ class ImapFlow extends EventEmitter {
     static version = packageInfo.version;
 
     /**
-     * @param {Object} options IMAP connection options
-     * @param {String} options.host Hostname of the IMAP server
-     * @param {Number} options.port Port number for the IMAP server
-     * @param {Boolean} [options.secure=false] Should the connection be established immediately and directly over TLS? Typically on port 993.
-     * @param {Boolean} [options.doSTARTTLS=undefined] Should the connection be established using STARTTLS?
-     *      * If `true`, the connection is first established as unencrypted and then upgraded to TLS using STARTTLS, before authentication.
-     *        If the server does not advertize the `STARTTLS` `CAPABILITY`, or the upgrade fails for other reasons, then the connection fails.
-     *        Note: The combination `secure=true` (direct TLS) and `doSTARTTLS=true` is invalid.
-     *      * If `false`, then STARTTLS will not be used, even if the server advertizes it in IMAP `CAPABILITY`.
-     *        This helps with servers that have a broken TLS configuration.
-     *        If `doSTARTTLS=false` and `secure=false`, then a plain unencrypted socket is used.
-     *        Be sure to clearly warn the user about the consequences.
-     *      * If `undefined` (default) and `secure=false` (default), the connection is upgraded using STARTTLS before authentication, /only if possible/ .
-     *        If not possible, the connection will use an unencrypted plain socket.
-     *        This can mean TLS is used under normal circumstances, but a serious attacker can force an unencrypted connection and steal passwords,
-     *        called "downgrade attack". This can lead to a false sense of security. Be sure to warn the user.
-     * @param {String} [options.servername] Servername for SNI (or when host is set to an IP address)
-     * @param {Boolean} [options.disableCompression=false] if `true` then client does not try to use COMPRESS=DEFLATE extension
-     * @param {Object} options.auth Authentication options. Authentication is requested automatically during <code>connect()</code>
-     * @param {String} options.auth.user Usename
-     * @param {String} [options.auth.pass] Password, if using regular authentication
-     * @param {String} [options.auth.accessToken] OAuth2 Access Token, if using OAuth2 authentication
-     * @param {IdInfoObject} [options.clientInfo] Client identification info
-     * @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] 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. Can be disabled by setting to `false`
-     * @param {Boolean} [options.logRaw=false] If true then log data read from and written to socket encoded in base64
-     * @param {Boolean} [options.emitLogs=false] If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
-     * @param {Boolean} [options.verifyOnly=false] If `true` then logs out automatically after successful authentication
-     * @param {String} [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 {String} [options.missingIdleCommand="NOOP"] Which command to use if server does not support IDLE
-     * @param {Boolean} [options.disableBinary=false] If true, then ignores the BINARY extension when making FETCH and APPEND calls
-     * @param {Boolean} [options.disableAutoEnable] Do not enable supported extensions by default
-     * @param {Number} [options.connectionTimeout=90000] how many milliseconds to wait for the connection to establish (default is 90 seconds)
-     * @param {Number} [options.greetingTimeout=16000] how many milliseconds to wait for the greeting after connection is established (default is 16 seconds)
-     * @param {Number} [options.socketTimeout=300000] how many milliseconds of inactivity to allow (default is 5 minutes)
+     * IMAP connection options
+     *
+     * @property {String} host
+     *     Hostname of the IMAP server.
+     *
+     * @property {Number} port
+     *     Port number for the IMAP server.
+     *
+     * @property {Boolean} [secure=false]
+     *     If `true`, establishes the connection directly over TLS (commonly on port 993).
+     *     If `false`, a plain (unencrypted) connection is used first and, if possible, the connection is upgraded to STARTTLS.
+     *
+     * @property {Boolean} [doSTARTTLS=undefined]
+     *     Determines whether to upgrade the connection to TLS via STARTTLS:
+     *       - **true**: Start unencrypted and upgrade to TLS using STARTTLS before authentication.
+     *         The connection fails if the server does not support STARTTLS or the upgrade fails.
+     *         Note that `secure=true` combined with `doSTARTTLS=true` is invalid.
+     *       - **false**: Never use STARTTLS, even if the server advertises support.
+     *         This is useful if the server has a broken TLS setup.
+     *         Combined with `secure=false`, this results in a fully unencrypted connection.
+     *         Make sure you warn users about the security risks.
+     *       - **undefined** (default): If `secure=false` (default), attempt to upgrade to TLS via STARTTLS before authentication if the server supports it. If not supported, continue unencrypted. This may expose the connection to a downgrade attack.
+     *
+     * @property {String} [servername]
+     *     Server name for SNI or when using an IP address as `host`.
+     *
+     * @property {Boolean} [disableCompression=false]
+     *     If `true`, the client does not attempt to use the COMPRESS=DEFLATE extension.
+     *
+     * @property {Object} auth
+     *     Authentication options. Authentication occurs automatically during {@link connect}.
+     *
+     * @property {String} auth.user
+     *     Username for authentication.
+     *
+     * @property {String} [auth.pass]
+     *     Password for regular authentication.
+     *
+     * @property {String} [auth.accessToken]
+     *     OAuth2 access token, if using OAuth2 authentication.
+     *
+     * @property {String} [auth.loginMethod]
+     *     Optional login method for password-based authentication (e.g., "LOGIN", "AUTH=LOGIN", or "AUTH=PLAIN").
+     *     If not set, ImapFlow chooses based on available mechanisms.
+     *
+     * @property {IdInfoObject} [clientInfo]
+     *     Client identification info sent to the server (via the ID command).
+     *
+     * @property {Boolean} [disableAutoIdle=false]
+     *     If `true`, do not start IDLE automatically. Useful when only specific operations are needed.
+     *
+     * @property {Object} [tls]
+     *     Additional TLS options. For details, see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback).
+     *
+     * @property {Boolean} [tls.rejectUnauthorized=true]
+     *     If `false`, allows self-signed or expired certificates.
+     *
+     * @property {String} [tls.minVersion='TLSv1.2']
+     *     Minimum accepted TLS version (e.g., `'TLSv1.2'`).
+     *
+     * @property {Number} [tls.minDHSize=1024]
+     *     Minimum size (in bits) of the DH parameter for TLS connections.
+     *
+     * @property {Object|Boolean} [logger]
+     *     Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)`, and `error(obj)` methods.
+     *     If `false`, logging is disabled. If not provided, ImapFlow logs to console in [pino format](https://getpino.io/).
+     *
+     * @property {Boolean} [logRaw=false]
+     *     If `true`, logs all raw data (read and written) in base64 encoding. You can pipe such logs to [eerawlog](https://github.com/postalsys/eerawlog) command for readable output.
+     *
+     * @property {Boolean} [emitLogs=false]
+     *     If `true`, emits `'log'` events with the same data passed to the logger.
+     *
+     * @property {Boolean} [verifyOnly=false]
+     *     If `true`, disconnects after successful authentication without performing other actions.
+     *
+     * @property {String} [proxy]
+     *     Proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`).
+     *
+     * @property {Boolean} [qresync=false]
+     *     If `true`, enables QRESYNC support so that EXPUNGE notifications include `uid` instead of `seq`.
+     *
+     * @property {Number} [maxIdleTime]
+     *     If set, breaks and restarts IDLE every `maxIdleTime` milliseconds.
+     *
+     * @property {String} [missingIdleCommand="NOOP"]
+     *     Command to use if the server does not support IDLE.
+     *
+     * @property {Boolean} [disableBinary=false]
+     *     If `true`, ignores the BINARY extension for FETCH and APPEND operations.
+     *
+     * @property {Boolean} [disableAutoEnable=false]
+     *     If `true`, do not automatically enable supported IMAP extensions.
+     *
+     * @property {Number} [connectionTimeout=90000]
+     *     Maximum time (in milliseconds) to wait for the connection to establish. Defaults to 90 seconds.
+     *
+     * @property {Number} [greetingTimeout=16000]
+     *     Maximum time (in milliseconds) to wait for the server greeting after a connection is established. Defaults to 16 seconds.
+     *
+     * @property {Number} [socketTimeout=300000]
+     *     Maximum period of inactivity (in milliseconds) before terminating the connection. Defaults to 5 minutes.
      */
+
     constructor(options) {
         super({ captureRejections: true });
 
@@ -277,10 +339,6 @@ class ImapFlow extends EventEmitter {
          */
         this.idling = false;
 
-        /**
-         * If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
-         * @type {Boolean}
-         */
         this.emitLogs = !!this.options.emitLogs;
         // ordering number for emitted logs
         this.lo = 0;
@@ -986,11 +1044,13 @@ class ImapFlow extends EventEmitter {
 
         this.expectCapabilityUpdate = true;
 
+        let loginMethod = (this.options.auth.loginMethod || '').toString().trim().toUpperCase();
+
         if (this.options.auth.accessToken) {
             this.authenticated = await this.run('AUTHENTICATE', this.options.auth.user, { accessToken: this.options.auth.accessToken });
         } else if (this.options.auth.pass) {
-            if (this.capabilities.has('AUTH=LOGIN') || this.capabilities.has('AUTH=PLAIN')) {
-                this.authenticated = await this.run('AUTHENTICATE', this.options.auth.user, { password: this.options.auth.pass });
+            if ((this.capabilities.has('AUTH=LOGIN') || this.capabilities.has('AUTH=PLAIN')) && loginMethod !== 'LOGIN') {
+                this.authenticated = await this.run('AUTHENTICATE', this.options.auth.user, { password: this.options.auth.pass, loginMethod });
             } else {
                 this.authenticated = await this.run('LOGIN', this.options.auth.user, this.options.auth.pass);
             }

package/lib/types.d.ts

@@ -4,83 +4,50 @@ declare module "imapflow" {
     import { EventEmitter } from "events";
 
     /**
-     * IMAP client class for accessing IMAP mailboxes
-     * @param options - IMAP connection options
-     * @param options.host - Hostname of the IMAP server
-     * @param options.port - Port number for the IMAP server
-     * @param [options.secure = false] - Should the connection be established immediately and directly over TLS? Typically on port 993.
-     * @param [options.doSTARTTLS] - Should the connection be established using STARTTLS?
-     *      * If `true`, the connection is first established as unencrypted and then upgraded to TLS using STARTTLS, before authentication.
-     *        If the server does not advertize the `STARTTLS` `CAPABILITY`, or the upgrade fails for other reasons, then the connection fails.
-     *        Note: The combination `secure=true` (direct TLS) and `doSTARTTLS=true` is invalid.
-     *      * If `false`, then STARTTLS will not be used, even if the server advertizes it in IMAP `CAPABILITY`.
-     *        This helps with servers that have a broken TLS configuration.
-     *        If `doSTARTTLS=false` and `secure=false`, then a plain unencrypted socket is used.
-     *        Be sure to clearly warn the user about the consequences.
-     *      * If `undefined` (default) and `secure=false` (default), the connection is upgraded using STARTTLS before authentication, /only if possible/ .
-     *        If not possible, the connection will use an unencrypted plain socket.
-     *        This can mean TLS is used under normal circumstances, but a serious attacker can force an unencrypted connection and steal passwords,
-     *        called "downgrade attack". This can lead to a false sense of security. Be sure to warn the user.
-     * @param [options.servername] - Servername for SNI (or when host is set to an IP address)
-     * @param [options.disableCompression = false] - if `true` then client does not try to use COMPRESS=DEFLATE extension
-     * @param options.auth - Authentication options. Authentication is requested automatically during <code>connect()</code>
-     * @param options.auth.user - Usename
-     * @param [options.auth.pass] - Password, if using regular authentication
-     * @param [options.auth.accessToken] - OAuth2 Access Token, if using OAuth2 authentication
-     * @param [options.clientInfo] - Client identification info
-     * @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] - 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. Can be disabled by setting to `false`
-     * @param [options.logRaw = false] - If true then log data read from and written to socket encoded in base64
-     * @param [options.emitLogs = false] - If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
-     * @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.missingIdleCommand = "NOOP"] - Which command to use if server does not support IDLE
-     * @param [options.disableBinary = false] - If true, then ignores the BINARY extension when making FETCH and APPEND calls
-     * @param [options.disableAutoEnable] - Do not enable supported extensions by default
-     * @param [options.connectionTimeout = 90000] - how many milliseconds to wait for the connection to establish (default is 90 seconds)
-     * @param [options.greetingTimeout = 16000] - how many milliseconds to wait for the greeting after connection is established (default is 16 seconds)
-     * @param [options.socketTimeout = 300000] - how many milliseconds of inactivity to allow (default is 5 minutes)
+     * IMAP connection options
+     * @property host - Hostname of the IMAP server.
+     * @property port - Port number for the IMAP server.
+     * @property [secure = false] - If `true`, establishes the connection directly over TLS (commonly on port 993).
+     *     If `false`, a plain (unencrypted) connection is used first and, if possible, the connection is upgraded to STARTTLS.
+     * @property [doSTARTTLS] - Determines whether to upgrade the connection to TLS via STARTTLS:
+     *       - **true**: Start unencrypted and upgrade to TLS using STARTTLS before authentication.
+     *         The connection fails if the server does not support STARTTLS or the upgrade fails.
+     *         Note that `secure=true` combined with `doSTARTTLS=true` is invalid.
+     *       - **false**: Never use STARTTLS, even if the server advertises support.
+     *         This is useful if the server has a broken TLS setup.
+     *         Combined with `secure=false`, this results in a fully unencrypted connection.
+     *         Make sure you warn users about the security risks.
+     *       - **undefined** (default): If `secure=false` (default), attempt to upgrade to TLS via STARTTLS before authentication if the server supports it. If not supported, continue unencrypted. This may expose the connection to a downgrade attack.
+     * @property [servername] - Server name for SNI or when using an IP address as `host`.
+     * @property [disableCompression = false] - If `true`, the client does not attempt to use the COMPRESS=DEFLATE extension.
+     * @property auth - Authentication options. Authentication occurs automatically during {@link connect}.
+     * @property auth.user - Username for authentication.
+     * @property [auth.pass] - Password for regular authentication.
+     * @property [auth.accessToken] - OAuth2 access token, if using OAuth2 authentication.
+     * @property [auth.loginMethod] - Optional login method for password-based authentication (e.g., "LOGIN", "AUTH=LOGIN", or "AUTH=PLAIN").
+     *     If not set, ImapFlow chooses based on available mechanisms.
+     * @property [clientInfo] - Client identification info sent to the server (via the ID command).
+     * @property [disableAutoIdle = false] - If `true`, do not start IDLE automatically. Useful when only specific operations are needed.
+     * @property [tls] - Additional TLS options. For details, see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback).
+     * @property [tls.rejectUnauthorized = true] - If `false`, allows self-signed or expired certificates.
+     * @property [tls.minVersion = 'TLSv1.2'] - Minimum accepted TLS version (e.g., `'TLSv1.2'`).
+     * @property [tls.minDHSize = 1024] - Minimum size (in bits) of the DH parameter for TLS connections.
+     * @property [logger] - Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)`, and `error(obj)` methods.
+     *     If `false`, logging is disabled. If not provided, ImapFlow logs to console in [pino format](https://getpino.io/).
+     * @property [logRaw = false] - If `true`, logs all raw data (read and written) in base64 encoding. You can pipe such logs to [eerawlog](https://github.com/postalsys/eerawlog) command for readable output.
+     * @property [emitLogs = false] - If `true`, emits `'log'` events with the same data passed to the logger.
+     * @property [verifyOnly = false] - If `true`, disconnects after successful authentication without performing other actions.
+     * @property [proxy] - Proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`).
+     * @property [qresync = false] - If `true`, enables QRESYNC support so that EXPUNGE notifications include `uid` instead of `seq`.
+     * @property [maxIdleTime] - If set, breaks and restarts IDLE every `maxIdleTime` milliseconds.
+     * @property [missingIdleCommand = "NOOP"] - Command to use if the server does not support IDLE.
+     * @property [disableBinary = false] - If `true`, ignores the BINARY extension for FETCH and APPEND operations.
+     * @property [disableAutoEnable = false] - If `true`, do not automatically enable supported IMAP extensions.
+     * @property [connectionTimeout = 90000] - Maximum time (in milliseconds) to wait for the connection to establish. Defaults to 90 seconds.
+     * @property [greetingTimeout = 16000] - Maximum time (in milliseconds) to wait for the server greeting after a connection is established. Defaults to 16 seconds.
+     * @property [socketTimeout = 300000] - Maximum period of inactivity (in milliseconds) before terminating the connection. Defaults to 5 minutes.
      */
     class ImapFlow extends EventEmitter {
-        constructor(options: {
-            host: string;
-            port: number;
-            secure?: boolean;
-            doSTARTTLS?: boolean;
-            servername?: string;
-            disableCompression?: boolean;
-            auth: {
-                user: string;
-                pass?: string;
-                accessToken?: string;
-            };
-            clientInfo?: IdInfoObject;
-            disableAutoIdle?: boolean;
-            tls?: {
-                rejectUnauthorized?: boolean;
-                minVersion?: string;
-                minDHSize?: number;
-            };
-            logger?: any;
-            logRaw?: boolean;
-            emitLogs?: boolean;
-            verifyOnly?: boolean;
-            proxy?: string;
-            qresync?: boolean;
-            maxIdleTime?: number;
-            missingIdleCommand?: string;
-            disableBinary?: boolean;
-            disableAutoEnable?: boolean;
-            connectionTimeout?: number;
-            greetingTimeout?: number;
-            socketTimeout?: number;
-        });
         /**
          * Current module version as a static class property
          * @property version - Module version
@@ -130,10 +97,6 @@ declare module "imapflow" {
          * Is current mailbox idling (`true`) or not (`false`)
          */
         idling: boolean;
-        /**
-         * If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
-         */
-        emitLogs: boolean;
         /**
          * Tries to upgrade the connection to TLS using STARTTLS.
          * @returns true, if the connection is now protected by TLS, either direct TLS or STARTTLS.
@@ -568,6 +531,117 @@ declare module "imapflow" {
         getMailboxLock(path: string | any[], options?: {
             readOnly?: boolean;
         }): Promise<MailboxLockObject>;
+        /**
+         * Hostname of the IMAP server.
+        */
+        host: string;
+        /**
+         * Port number for the IMAP server.
+        */
+        port: number;
+        /**
+         * If `true`, establishes the connection directly over TLS (commonly on port 993).
+            If `false`, a plain (unencrypted) connection is used first and, if possible, the connection is upgraded to STARTTLS.
+        */
+        secure?: boolean;
+        /**
+         * Determines whether to upgrade the connection to TLS via STARTTLS:
+              - **true**: Start unencrypted and upgrade to TLS using STARTTLS before authentication.
+                The connection fails if the server does not support STARTTLS or the upgrade fails.
+                Note that `secure=true` combined with `doSTARTTLS=true` is invalid.
+              - **false**: Never use STARTTLS, even if the server advertises support.
+                This is useful if the server has a broken TLS setup.
+                Combined with `secure=false`, this results in a fully unencrypted connection.
+                Make sure you warn users about the security risks.
+              - **undefined** (default): If `secure=false` (default), attempt to upgrade to TLS via STARTTLS before authentication if the server supports it. If not supported, continue unencrypted. This may expose the connection to a downgrade attack.
+        */
+        doSTARTTLS?: boolean;
+        /**
+         * Server name for SNI or when using an IP address as `host`.
+        */
+        servername?: string;
+        /**
+         * If `true`, the client does not attempt to use the COMPRESS=DEFLATE extension.
+        */
+        disableCompression?: boolean;
+        /**
+         * Authentication options. Authentication occurs automatically during {@link connect}.
+        */
+        auth: {
+            user: string;
+            pass?: string;
+            accessToken?: string;
+            loginMethod?: string;
+        };
+        /**
+         * Client identification info sent to the server (via the ID command).
+        */
+        clientInfo?: IdInfoObject;
+        /**
+         * If `true`, do not start IDLE automatically. Useful when only specific operations are needed.
+        */
+        disableAutoIdle?: boolean;
+        /**
+         * Additional TLS options. For details, see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback).
+        */
+        tls?: {
+            rejectUnauthorized?: boolean;
+            minVersion?: string;
+            minDHSize?: number;
+        };
+        /**
+         * Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)`, and `error(obj)` methods.
+            If `false`, logging is disabled. If not provided, ImapFlow logs to console in [pino format](https://getpino.io/).
+        */
+        logger?: any | boolean;
+        /**
+         * If `true`, logs all raw data (read and written) in base64 encoding. You can pipe such logs to [eerawlog](https://github.com/postalsys/eerawlog) command for readable output.
+        */
+        logRaw?: boolean;
+        /**
+         * If `true`, emits `'log'` events with the same data passed to the logger.
+        */
+        emitLogs?: boolean;
+        /**
+         * If `true`, disconnects after successful authentication without performing other actions.
+        */
+        verifyOnly?: boolean;
+        /**
+         * Proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`).
+        */
+        proxy?: string;
+        /**
+         * If `true`, enables QRESYNC support so that EXPUNGE notifications include `uid` instead of `seq`.
+        */
+        qresync?: boolean;
+        /**
+         * If set, breaks and restarts IDLE every `maxIdleTime` milliseconds.
+        */
+        maxIdleTime?: number;
+        /**
+         * Command to use if the server does not support IDLE.
+        */
+        missingIdleCommand?: string;
+        /**
+         * If `true`, ignores the BINARY extension for FETCH and APPEND operations.
+        */
+        disableBinary?: boolean;
+        /**
+         * If `true`, do not automatically enable supported IMAP extensions.
+        */
+        disableAutoEnable?: boolean;
+        /**
+         * Maximum time (in milliseconds) to wait for the connection to establish. Defaults to 90 seconds.
+        */
+        connectionTimeout?: number;
+        /**
+         * Maximum time (in milliseconds) to wait for the server greeting after a connection is established. Defaults to 16 seconds.
+        */
+        greetingTimeout?: number;
+        /**
+         * Maximum period of inactivity (in milliseconds) before terminating the connection. Defaults to 5 minutes.
+        */
+        socketTimeout?: number;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.171",
+    "version": "1.0.172",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -32,7 +32,7 @@
         "@babel/eslint-plugin": "7.25.9",
         "@babel/plugin-syntax-class-properties": "7.12.13",
         "@babel/preset-env": "7.26.0",
-        "@types/node": "22.10.1",
+        "@types/node": "22.10.5",
         "eslint": "8.57.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.1.0",
@@ -53,7 +53,7 @@
         "libqp": "2.1.1",
         "mailsplit": "5.4.2",
         "nodemailer": "6.9.16",
-        "pino": "9.5.0",
+        "pino": "9.6.0",
         "socks": "2.8.3"
     }
 }

package/test/imap-parser-test.js

@@ -1006,7 +1006,6 @@ module.exports['IMAP Parser, subfolder square bracket'] = test =>
 module.exports['IMAP Parser, FETCH with full range'] = test =>
     asyncWrapper(test, async test => {
         let parsed = await parser('* 32 FETCH (UID 32 RFC822.SIZE 3991 BODY[2.MIME] "(* 61B literal *)" BODY[2]<0.65536> "(* 6B literal *)")');
-        console.log(JSON.stringify(parsed.attributes));
         test.deepEqual(parsed.attributes, [
             {
                 type: 'ATOM',
@@ -1061,3 +1060,180 @@ module.exports['IMAP Parser, FETCH with full range'] = test =>
             ]
         ]);
     });
+
+module.exports['IMAP Parser, FETCH with BODYSTRUCTURE'] = test =>
+    asyncWrapper(test, async test => {
+        let parsed = await parser(
+            '* 1013 FETCH (UID 2986 MODSEQ (4960) BODYSTRUCTURE (("text" "plain" ("charset" "us-ascii") NIL NIL "7bit" 16 1 NIL NIL NIL NIL)("message" "rfc822" ("name" "Tellimuse Microsoft 365 Business Standard arve vaatamine.eml") NIL NIL "7bit" 370684 ("Mon, 16 Dec 2024 03:28:28 +0000" "Tellimuse Microsoft 365 Business Standard arve vaatamine" (("Microsoft" NIL "microsoft-noreply" "microsoft.com")) (("Microsoft" NIL "microsoft-noreply" "microsoft.com")) (("Microsoft" NIL "microsoft-noreply" "microsoft.com")) ((NIL NIL "andris.reinman" "gmail.com")) NIL NIL NIL "<58710631-775f-4c07-96ff-28a776f44d90@az.eastus2.microsoft.com>") ((("text" "plain" ("charset" "utf-8") NIL NIL "quoted-printable" 2866 80 NIL NIL NIL NIL)("text" "html" ("charset" "utf-8") NIL NIL "quoted-printable" 78392 1770 NIL NIL NIL NIL) "alternative" ("boundary" "=-EcWGOW6mwE+0T4lm385OWw==") NIL NIL NIL)("application" "octet-stream" ("name" "52482541500.pdf") NIL NIL "base64" 279430 NIL ("attachment" ("filename" "52482541500.pdf")) NIL NIL) "mixed" ("boundary" "=-1wJq2CLBJ6H+Zk2GPX9FKw==") NIL NIL NIL) 5580 NIL ("attachment" ("filename" "Tellimuse Microsoft 365 Business Standard arve vaatamine.eml")) NIL NIL) "mixed" ("boundary" "Apple-Mail=_F700EE9B-43B1-4EF1-95EE-CAA13391B333") NIL NIL NIL))'
+        );
+
+        test.deepEqual(parsed.attributes, [
+            { type: 'ATOM', value: 'FETCH' },
+            [
+                { type: 'ATOM', value: 'UID' },
+                { type: 'ATOM', value: '2986' },
+                { type: 'ATOM', value: 'MODSEQ' },
+                [{ type: 'ATOM', value: '4960' }],
+                { type: 'ATOM', value: 'BODYSTRUCTURE' },
+                [
+                    [
+                        { type: 'STRING', value: 'text' },
+                        { type: 'STRING', value: 'plain' },
+                        [
+                            { type: 'STRING', value: 'charset' },
+                            { type: 'STRING', value: 'us-ascii' }
+                        ],
+                        null,
+                        null,
+                        { type: 'STRING', value: '7bit' },
+                        { type: 'ATOM', value: '16' },
+                        { type: 'ATOM', value: '1' },
+                        null,
+                        null,
+                        null,
+                        null
+                    ],
+                    [
+                        { type: 'STRING', value: 'message' },
+                        { type: 'STRING', value: 'rfc822' },
+                        [
+                            { type: 'STRING', value: 'name' },
+                            { type: 'STRING', value: 'Tellimuse Microsoft 365 Business Standard arve vaatamine.eml' }
+                        ],
+                        null,
+                        null,
+                        { type: 'STRING', value: '7bit' },
+                        { type: 'ATOM', value: '370684' },
+                        [
+                            { type: 'STRING', value: 'Mon, 16 Dec 2024 03:28:28 +0000' },
+                            { type: 'STRING', value: 'Tellimuse Microsoft 365 Business Standard arve vaatamine' },
+                            [
+                                [
+                                    { type: 'STRING', value: 'Microsoft' },
+                                    null,
+                                    { type: 'STRING', value: 'microsoft-noreply' },
+                                    { type: 'STRING', value: 'microsoft.com' }
+                                ]
+                            ],
+                            [
+                                [
+                                    { type: 'STRING', value: 'Microsoft' },
+                                    null,
+                                    { type: 'STRING', value: 'microsoft-noreply' },
+                                    { type: 'STRING', value: 'microsoft.com' }
+                                ]
+                            ],
+                            [
+                                [
+                                    { type: 'STRING', value: 'Microsoft' },
+                                    null,
+                                    { type: 'STRING', value: 'microsoft-noreply' },
+                                    { type: 'STRING', value: 'microsoft.com' }
+                                ]
+                            ],
+                            [[null, null, { type: 'STRING', value: 'andris.reinman' }, { type: 'STRING', value: 'gmail.com' }]],
+                            null,
+                            null,
+                            null,
+                            { type: 'STRING', value: '<58710631-775f-4c07-96ff-28a776f44d90@az.eastus2.microsoft.com>' }
+                        ],
+                        [
+                            [
+                                [
+                                    { type: 'STRING', value: 'text' },
+                                    { type: 'STRING', value: 'plain' },
+                                    [
+                                        { type: 'STRING', value: 'charset' },
+                                        { type: 'STRING', value: 'utf-8' }
+                                    ],
+                                    null,
+                                    null,
+                                    { type: 'STRING', value: 'quoted-printable' },
+                                    { type: 'ATOM', value: '2866' },
+                                    { type: 'ATOM', value: '80' },
+                                    null,
+                                    null,
+                                    null,
+                                    null
+                                ],
+                                [
+                                    { type: 'STRING', value: 'text' },
+                                    { type: 'STRING', value: 'html' },
+                                    [
+                                        { type: 'STRING', value: 'charset' },
+                                        { type: 'STRING', value: 'utf-8' }
+                                    ],
+                                    null,
+                                    null,
+                                    { type: 'STRING', value: 'quoted-printable' },
+                                    { type: 'ATOM', value: '78392' },
+                                    { type: 'ATOM', value: '1770' },
+                                    null,
+                                    null,
+                                    null,
+                                    null
+                                ],
+                                { type: 'STRING', value: 'alternative' },
+                                [
+                                    { type: 'STRING', value: 'boundary' },
+                                    { type: 'STRING', value: '=-EcWGOW6mwE+0T4lm385OWw==' }
+                                ],
+                                null,
+                                null,
+                                null
+                            ],
+                            [
+                                { type: 'STRING', value: 'application' },
+                                { type: 'STRING', value: 'octet-stream' },
+                                [
+                                    { type: 'STRING', value: 'name' },
+                                    { type: 'STRING', value: '52482541500.pdf' }
+                                ],
+                                null,
+                                null,
+                                { type: 'STRING', value: 'base64' },
+                                { type: 'ATOM', value: '279430' },
+                                null,
+                                [
+                                    { type: 'STRING', value: 'attachment' },
+                                    [
+                                        { type: 'STRING', value: 'filename' },
+                                        { type: 'STRING', value: '52482541500.pdf' }
+                                    ]
+                                ],
+                                null,
+                                null
+                            ],
+                            { type: 'STRING', value: 'mixed' },
+                            [
+                                { type: 'STRING', value: 'boundary' },
+                                { type: 'STRING', value: '=-1wJq2CLBJ6H+Zk2GPX9FKw==' }
+                            ],
+                            null,
+                            null,
+                            null
+                        ],
+                        { type: 'ATOM', value: '5580' },
+                        null,
+                        [
+                            { type: 'STRING', value: 'attachment' },
+                            [
+                                { type: 'STRING', value: 'filename' },
+                                { type: 'STRING', value: 'Tellimuse Microsoft 365 Business Standard arve vaatamine.eml' }
+                            ]
+                        ],
+                        null,
+                        null
+                    ],
+                    { type: 'STRING', value: 'mixed' },
+                    [
+                        { type: 'STRING', value: 'boundary' },
+                        { type: 'STRING', value: 'Apple-Mail=_F700EE9B-43B1-4EF1-95EE-CAA13391B333' }
+                    ],
+                    null,
+                    null,
+                    null
+                ]
+            ]
+        ]);
+    });