imapflow 1.0.109 → 1.0.111

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+-   1.0.111 - 2022-10-13
+
+    -   Added new connection options
+        -   connectionTimeout=90000: how many milliseconds to wait for the connection to establish (default is 90 seconds)
+        -   greetingTimeout=16000: how many milliseconds to wait for the greeting after connection is established (default is 16 seconds)
+        -   socketTimeout=300000: how many milliseconds of inactivity to allow (default is 5 minutes)
+
+-   1.0.110 - 2022-10-10
+
+    -   Allow unicode atoms by default
+
 -   1.0.109 - 2022-09-29
 
     -   New method `downloadMany`

package/lib/handler/token-parser.js

@@ -271,7 +271,8 @@ class TokenParser {
                             // Any ATOM supported char starts a new Atom sequence, otherwise throw an error
                             // Allow \ as the first char for atom to support system flags
                             // Allow % to support LIST '' %
-                            if (imapFormalSyntax['ATOM-CHAR']().indexOf(chr) < 0 && chr !== '\\' && chr !== '%') {
+                            // Allow 8bit characters (presumably unicode)
+                            if (imapFormalSyntax['ATOM-CHAR']().indexOf(chr) < 0 && chr !== '\\' && chr !== '%' && chr.charCodeAt(0) < 0x80) {
                                 throw new Error(`Unexpected char at position ${this.pos + i} [E10: ${JSON.stringify(chr)}]`);
                             }
 
@@ -336,6 +337,7 @@ class TokenParser {
                     // if the char is not ATOM compatible, throw. Allow \* as an exception
                     if (
                         imapFormalSyntax['ATOM-CHAR']().indexOf(chr) < 0 &&
+                        chr.charCodeAt(0) < 0x80 && // allow 8bit (presumably unicode) bytes
                         chr !== ']' &&
                         !(chr === '*' && this.currentNode.value === '\\') &&
                         (!this.parent || !this.parent.command || !['NO', 'BAD', 'OK'].includes(this.parent.command))

package/lib/imap-flow.js

@@ -132,6 +132,9 @@ class ImapFlow extends EventEmitter {
      * @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
      * @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)
      */
     constructor(options) {
         super({ captureRejections: true });
@@ -1187,23 +1190,29 @@ class ImapFlow extends EventEmitter {
             this.connectTimeout = setTimeout(() => {
                 let err = new Error('Failed to established connection in required time');
                 err.code = 'CONNECT_TIMEOUT';
+                err.details = {
+                    connectionTimeout: this.options.connectionTimeout || CONNECT_TIMEOUT
+                };
                 this.log.error({ err, cid: this.id });
                 setImmediate(() => this.close());
                 reject(err);
-            }, CONNECT_TIMEOUT);
+            }, this.options.connectionTimeout || CONNECT_TIMEOUT);
 
             let onConnect = () => {
                 clearTimeout(this.connectTimeout);
                 this.socket.setKeepAlive(true, 5 * 1000);
-                this.socket.setTimeout(SOCKET_TIMEOUT);
+                this.socket.setTimeout(this.options.socketTimeout || SOCKET_TIMEOUT);
 
                 this.greetingTimeout = setTimeout(() => {
                     let err = new Error(`Failed to receive greeting from server in required time${!this.secureConnection ? '. Maybe should use TLS?' : ''}`);
                     err.code = 'GREEETING_TIMEOUT';
+                    err.details = {
+                        greetingTimeout: this.options.greetingTimeout || GREETING_TIMEOUT
+                    };
                     this.log.error({ err, cid: this.id });
                     setImmediate(() => this.close());
                     reject(err);
-                }, GREETING_TIMEOUT);
+                }, this.options.greetingTimeout || GREETING_TIMEOUT);
 
                 this.tls = typeof this.socket.getCipher === 'function' ? this.socket.getCipher() : false;
 
@@ -2163,6 +2172,7 @@ class ImapFlow extends EventEmitter {
      * @typedef {Object} DownloadObject
      * @global
      * @property {Object} meta content metadata
+     * @property {number} meta.expectedSize The fetch response size
      * @property {String} meta.contentType Content-Type of the streamed file. If part was not set then this value is "message/rfc822"
      * @property {String} [meta.charset] Charset of the body part. Text parts are automaticaly converted to UTF-8, attachments are kept as is
      * @property {String} [meta.disposition] Content-Disposition of the streamed file

package/lib/types.d.ts

@@ -31,6 +31,9 @@ declare module "imapflow" {
      * @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
      * @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)
      */
     class ImapFlow extends EventEmitter {
         constructor(options: {
@@ -60,6 +63,9 @@ declare module "imapflow" {
             maxIdleTime?: number;
             disableBinary?: boolean;
             disableAutoEnable?: boolean;
+            connectionTimeout?: number;
+            greetingTimeout?: number;
+            socketTimeout?: number;
         });
         /**
          * Current module version as a static class property
@@ -941,6 +947,7 @@ declare type FetchMessageObject = {
 
 /**
  * @property meta - content metadata
+ * @property meta.expectedSize - The fetch response size
  * @property meta.contentType - Content-Type of the streamed file. If part was not set then this value is "message/rfc822"
  * @property [meta.charset] - Charset of the body part. Text parts are automaticaly converted to UTF-8, attachments are kept as is
  * @property [meta.disposition] - Content-Disposition of the streamed file
@@ -949,6 +956,7 @@ declare type FetchMessageObject = {
  */
 declare type DownloadObject = {
     meta: {
+        expectedSize: number;
         contentType: string;
         charset?: string;
         disposition?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.109",
+    "version": "1.0.111",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -30,10 +30,10 @@
         "@babel/eslint-parser": "7.19.1",
         "@babel/eslint-plugin": "7.19.1",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.19.3",
-        "@types/node": "18.7.23",
+        "@babel/preset-env": "7.19.4",
+        "@types/node": "18.8.5",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.24.0",
+        "eslint": "8.25.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.5.0",
         "grunt": "1.5.3",
@@ -53,6 +53,6 @@
         "mailsplit": "5.3.2",
         "nodemailer": "6.8.0",
         "pino": "8.6.1",
-        "socks": "2.7.0"
+        "socks": "2.7.1"
     }
 }

package/test/imap-parser-test.js

@@ -941,3 +941,32 @@ module.exports['IMAP Parser, single quote in atom'] = test =>
             { type: 'ATOM', value: "'a" }
         ])
     );
+
+module.exports['IMAP Parser, unicode status 1'] = test =>
+    asyncWrapper(test, async test =>
+        test.deepEqual((await parser('* STATUS Segregator/Społeczności (MESSAGES 0 UIDNEXT 1 UIDVALIDITY 1)')).attributes, [
+            { type: 'ATOM', value: 'Segregator/Społeczności' },
+            [
+                { type: 'ATOM', value: 'MESSAGES' },
+                { type: 'ATOM', value: '0' },
+                { type: 'ATOM', value: 'UIDNEXT' },
+                { type: 'ATOM', value: '1' },
+                { type: 'ATOM', value: 'UIDVALIDITY' },
+                { type: 'ATOM', value: '1' }
+            ]
+        ])
+    );
+module.exports['IMAP Parser, unicode status 12'] = test =>
+    asyncWrapper(test, async test =>
+        test.deepEqual((await parser('* STATUS Šegregator/Społeczności (MESSAGES 0 UIDNEXT 1 UIDVALIDITY 1)')).attributes, [
+            { type: 'ATOM', value: 'Šegregator/Społeczności' },
+            [
+                { type: 'ATOM', value: 'MESSAGES' },
+                { type: 'ATOM', value: '0' },
+                { type: 'ATOM', value: 'UIDNEXT' },
+                { type: 'ATOM', value: '1' },
+                { type: 'ATOM', value: 'UIDVALIDITY' },
+                { type: 'ATOM', value: '1' }
+            ]
+        ])
+    );