imapflow 1.0.125 → 1.0.126

package/README.md

@@ -10,7 +10,7 @@ ImapFlow is a modern and easy-to-use IMAP client library for Node.js.
 
 The focus for ImapFlow is to provide easy to use API over IMAP. Using ImapFlow does not expect knowledge about specific IMAP details. A general understanding is good enough.
 
-IMAP extensions are handled in the background, so, for example, you can always request `labels` value from a {@link FetchQueryObject|fetch()} call, but if the IMAP server does not support `X-GM-EXT1` extension, then `labels` value is not included in the response.
+IMAP extensions are handled in the background, so, for example, you can always request `labels` value from a {@link FetchQueryObject|fetch()} call, but if the IMAP server does not support `X-GM-EXT-1` extension, then `labels` value is not included in the response.
 
 ## Source
 

package/lib/imap-flow.js

@@ -2224,7 +2224,7 @@ class ImapFlow extends EventEmitter {
      *
      * @example
      * let mailbox = await client.mailboxOpen('INBOX');
-     * // fetch UID for all messages in a mailbox
+     * // fetch UID for the last email in the selected mailbox
      * let lastMsg = await client.fetchOne('*', {uid: true})
      * console.log(lastMsg.uid);
      */
@@ -2555,7 +2555,7 @@ class ImapFlow extends EventEmitter {
      *
      * @example
      * let mailbox = await client.mailboxOpen('INBOX');
-     * // download body part nr '1.2' from latest message
+     * // download body parts '2', and '3' from all messages in the selected mailbox
      * let response = await client.downloadMany('*', ['2', '3]);
      * process.stdout.write(response[2].content)
      * process.stdout.write(response[3].content)

package/lib/search-compiler.js

@@ -39,9 +39,18 @@ let processDateField = (attributes, term, value) => {
     setOpt(attributes, term, date);
 };
 
+let isUnicodeString = str => {
+    if (!str || typeof str !== 'string') {
+        return false;
+    }
+
+    return Buffer.byteLength(str) !== str.length;
+};
+
 module.exports.searchCompiler = (connection, query) => {
     const attributes = [];
 
+    let hasUnicode = false;
     const mailbox = connection.mailbox;
 
     const walk = params => {
@@ -82,16 +91,24 @@ module.exports.searchCompiler = (connection, query) => {
                     }
                     break;
 
+                case 'LARGER':
+                case 'SMALLER':
+                case 'MODSEQ':
+                    if (params[term]) {
+                        setOpt(attributes, term, params[term]);
+                    }
+                    break;
+
                 case 'BCC':
                 case 'BODY':
                 case 'CC':
                 case 'FROM':
-                case 'LARGER':
-                case 'SMALLER':
                 case 'SUBJECT':
                 case 'TEXT':
                 case 'TO':
-                case 'MODSEQ':
+                    if (isUnicodeString(params[term])) {
+                        hasUnicode = true;
+                    }
                     if (params[term]) {
                         setOpt(attributes, term, params[term]);
                     }
@@ -110,6 +127,7 @@ module.exports.searchCompiler = (connection, query) => {
                         setOpt(attributes, 'X-GM-MSGID', params[term]);
                     }
                     break;
+
                 case 'THREADID':
                     if (connection.capabilities.has('OBJECTID')) {
                         setOpt(attributes, 'THREADID', params[term]);
@@ -117,9 +135,13 @@ module.exports.searchCompiler = (connection, query) => {
                         setOpt(attributes, 'X-GM-THRID', params[term]);
                     }
                     break;
+
                 case 'GMRAW':
                 case 'GMAILRAW': // alias for GMRAW
                     if (connection.capabilities.has('X-GM-EXT-1')) {
+                        if (isUnicodeString(params[term])) {
+                            hasUnicode = true;
+                        }
                         setOpt(attributes, 'X-GM-RAW', params[term]);
                     } else {
                         let error = new Error('Server does not support X-GM-EXT-1 extension required for X-GM-RAW');
@@ -159,6 +181,10 @@ module.exports.searchCompiler = (connection, query) => {
                                 return;
                             }
 
+                            if (isUnicodeString(value)) {
+                                hasUnicode = true;
+                            }
+
                             setOpt(attributes, term, [header.toUpperCase().trim(), value]);
                         });
                     }
@@ -233,5 +259,10 @@ module.exports.searchCompiler = (connection, query) => {
 
     walk(query);
 
+    if (hasUnicode) {
+        attributes.unshift({ type: 'ATOM', value: 'UTF-8' });
+        attributes.unshift({ type: 'ATOM', value: 'CHARSET' });
+    }
+
     return attributes;
 };

package/lib/types.d.ts

@@ -461,7 +461,7 @@ declare module "imapflow" {
          * Fetch a single message from currently opened mailbox
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
-         * // fetch UID for all messages in a mailbox
+         * // fetch UID for the last email in the selected mailbox
          * let lastMsg = await client.fetchOne('*', {uid: true})
          * console.log(lastMsg.uid);
          * @param seq - Single UID or sequence number of the message to fetch for
@@ -499,7 +499,7 @@ declare module "imapflow" {
          * Fetch multiple attachments as Buffer values
          * @example
          * let mailbox = await client.mailboxOpen('INBOX');
-         * // download body part nr '1.2' from latest message
+         * // download body parts '2', and '3' from all messages in the selected mailbox
          * let response = await client.downloadMany('*', ['2', '3]);
          * process.stdout.write(response[2].content)
          * process.stdout.write(response[3].content)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.125",
+    "version": "1.0.126",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -30,10 +30,10 @@
         "@babel/eslint-parser": "7.21.3",
         "@babel/eslint-plugin": "7.19.1",
         "@babel/plugin-syntax-class-properties": "7.12.13",
-        "@babel/preset-env": "7.20.2",
-        "@types/node": "18.15.10",
+        "@babel/preset-env": "7.21.4",
+        "@types/node": "18.15.11",
         "braintree-jsdoc-template": "3.3.0",
-        "eslint": "8.36.0",
+        "eslint": "8.37.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.8.0",
         "grunt": "1.6.1",