imapflow 2.9.0 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.10.0](https://github.com/postalsys/imapflow/compare/v2.9.1...v2.10.0) (2026-10-29)
+
+
+### Features
+
+* add decodeText option to download() for transfer-decoded file bytes ([9c9bec2](https://github.com/postalsys/imapflow/commit/9c9bec225efe0dfb7b1b31271f4fa76783f15adb)), closes [#455](https://github.com/postalsys/imapflow/issues/455)
+
+## [2.9.1](https://github.com/postalsys/imapflow/compare/v2.9.0...v2.9.1) (2026-10-22)
+
+
+### Bug Fixes
+
+* update dependencies ([bf20e37](https://github.com/postalsys/imapflow/commit/bf20e3734628a99969b63db3cd8458d6043a8ba5))
+
 ## [2.9.0](https://github.com/postalsys/imapflow/compare/v2.8.0...v2.9.0) (2026-10-22)
 
 

package/dist/cjs/download.js

@@ -351,8 +351,8 @@ async function downloadMessage(client, range, part, options) {
     }
     // Build a decoder pipeline that progressively transforms the raw FETCH data:
     //   1. Transfer-encoding decoder (base64 or quoted-printable -> binary)
-    //   2. Format decoder (format=flowed -> plain text, if applicable)
-    //   3. Charset decoder (non-UTF-8 -> UTF-8, for text parts only)
+    //   2. Format decoder (format=flowed -> plain text, if applicable, unless decodeText is false)
+    //   3. Charset decoder (non-UTF-8 -> UTF-8, for text parts only, unless decodeText is false)
     //   4. Byte limiter (enforces maxBytes cap)
     // `stream` is the head of the pipeline (where raw chunks are written),
     // `output` is the tail (what the caller reads from).
@@ -394,7 +394,7 @@ async function downloadMessage(client, range, part, options) {
         return stage;
     };
     let isTextNode = ['text/html', 'text/plain', 'text/x-amp-html'].includes(meta.contentType) || (part === '1' && !meta.contentType);
-    if ((!meta.disposition || meta.disposition === 'inline') && isTextNode) {
+    if (downloadOptions.decodeText !== false && (!meta.disposition || meta.disposition === 'inline') && isTextNode) {
         // RFC 3676 format=flowed text: unwrap soft line breaks
         if (meta.flowed) {
             // FlowedDecoder buffers its whole input before emitting, and being third party it

package/dist/cjs/imap-flow.d.ts

@@ -606,8 +606,8 @@ export declare class ImapFlow extends EventEmitter {
     fetchOne(seq: SequenceString, query: FetchQueryObject, options?: FetchOptions | undefined): Promise<FetchMessageObject | false>;
     /**
      * Download either full rfc822 formatted message or a specific bodystructure part as a Stream.
-     * Bodystructure parts are decoded so the resulting stream is a binary file. Text content
-     * is automatically converted to UTF-8 charset.
+     * Bodystructure parts are decoded so the resulting stream is a binary file. Inline text content
+     * is automatically converted to UTF-8 charset, unless `options.decodeText` is false.
      *
      * @param range UID or sequence number for the message to fetch
      * @param part If not set then downloads entire rfc822 formatted message, otherwise downloads specific bodystructure part

package/dist/cjs/imap-flow.js

@@ -3451,8 +3451,8 @@ class ImapFlow extends node_events_1.EventEmitter {
     }
     /**
      * Download either full rfc822 formatted message or a specific bodystructure part as a Stream.
-     * Bodystructure parts are decoded so the resulting stream is a binary file. Text content
-     * is automatically converted to UTF-8 charset.
+     * Bodystructure parts are decoded so the resulting stream is a binary file. Inline text content
+     * is automatically converted to UTF-8 charset, unless `options.decodeText` is false.
      *
      * @param range UID or sequence number for the message to fetch
      * @param part If not set then downloads entire rfc822 formatted message, otherwise downloads specific bodystructure part

package/dist/cjs/package-info.d.ts

@@ -1,3 +1,3 @@
 export declare const name = "imapflow";
-export declare const version = "2.9.0";
+export declare const version = "2.10.0";
 export declare const homepage = "https://imapflow.com/";

package/dist/cjs/package-info.js

@@ -3,5 +3,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.homepage = exports.version = exports.name = void 0;
 exports.name = "imapflow";
-exports.version = "2.9.0";
+exports.version = "2.10.0";
 exports.homepage = "https://imapflow.com/";

package/dist/cjs/types.d.ts

@@ -684,8 +684,18 @@ export interface DownloadOptions {
     chunkSize?: number | undefined;
     /** If true then requests the content with FETCH BINARY when the server supports it (BINARY or IMAP4rev2), so the server removes the transfer encoding */
     binary?: boolean | undefined;
+    /**
+     * If false then text parts are not decoded: inline `text/plain`, `text/html` and `text/x-amp-html`
+     * parts are streamed with only the transfer encoding removed, as for any other part, without
+     * unwrapping `format=flowed` lines or converting the charset to UTF-8, and `meta.charset` keeps the
+     * charset of the part. Use it to save a text part as a file. Defaults to true
+     */
+    decodeText?: boolean | undefined;
 }
-/** Options for downloadMany(): the download() options without `chunkSize`, as the parts come in one FETCH */
+/**
+ * Options for downloadMany(): the download() options without `chunkSize`, as the parts come in one FETCH, and without
+ * `decodeText`, as downloadMany() only removes the transfer encoding and never converts text
+ */
 export type DownloadManyOptions = Pick<DownloadOptions, 'uid' | 'maxBytes' | 'binary'>;
 export interface DownloadManyPart {
     meta: DownloadMeta;

package/dist/esm/download.js

@@ -344,8 +344,8 @@ export async function downloadMessage(client, range, part, options) {
     }
     // Build a decoder pipeline that progressively transforms the raw FETCH data:
     //   1. Transfer-encoding decoder (base64 or quoted-printable -> binary)
-    //   2. Format decoder (format=flowed -> plain text, if applicable)
-    //   3. Charset decoder (non-UTF-8 -> UTF-8, for text parts only)
+    //   2. Format decoder (format=flowed -> plain text, if applicable, unless decodeText is false)
+    //   3. Charset decoder (non-UTF-8 -> UTF-8, for text parts only, unless decodeText is false)
     //   4. Byte limiter (enforces maxBytes cap)
     // `stream` is the head of the pipeline (where raw chunks are written),
     // `output` is the tail (what the caller reads from).
@@ -387,7 +387,7 @@ export async function downloadMessage(client, range, part, options) {
         return stage;
     };
     let isTextNode = ['text/html', 'text/plain', 'text/x-amp-html'].includes(meta.contentType) || (part === '1' && !meta.contentType);
-    if ((!meta.disposition || meta.disposition === 'inline') && isTextNode) {
+    if (downloadOptions.decodeText !== false && (!meta.disposition || meta.disposition === 'inline') && isTextNode) {
         // RFC 3676 format=flowed text: unwrap soft line breaks
         if (meta.flowed) {
             // FlowedDecoder buffers its whole input before emitting, and being third party it

package/dist/esm/imap-flow.d.ts

@@ -606,8 +606,8 @@ export declare class ImapFlow extends EventEmitter {
     fetchOne(seq: SequenceString, query: FetchQueryObject, options?: FetchOptions | undefined): Promise<FetchMessageObject | false>;
     /**
      * Download either full rfc822 formatted message or a specific bodystructure part as a Stream.
-     * Bodystructure parts are decoded so the resulting stream is a binary file. Text content
-     * is automatically converted to UTF-8 charset.
+     * Bodystructure parts are decoded so the resulting stream is a binary file. Inline text content
+     * is automatically converted to UTF-8 charset, unless `options.decodeText` is false.
      *
      * @param range UID or sequence number for the message to fetch
      * @param part If not set then downloads entire rfc822 formatted message, otherwise downloads specific bodystructure part

package/dist/esm/imap-flow.js

@@ -3408,8 +3408,8 @@ export class ImapFlow extends EventEmitter {
     }
     /**
      * Download either full rfc822 formatted message or a specific bodystructure part as a Stream.
-     * Bodystructure parts are decoded so the resulting stream is a binary file. Text content
-     * is automatically converted to UTF-8 charset.
+     * Bodystructure parts are decoded so the resulting stream is a binary file. Inline text content
+     * is automatically converted to UTF-8 charset, unless `options.decodeText` is false.
      *
      * @param range UID or sequence number for the message to fetch
      * @param part If not set then downloads entire rfc822 formatted message, otherwise downloads specific bodystructure part

package/dist/esm/package-info.d.ts

@@ -1,3 +1,3 @@
 export declare const name = "imapflow";
-export declare const version = "2.9.0";
+export declare const version = "2.10.0";
 export declare const homepage = "https://imapflow.com/";

package/dist/esm/package-info.js

@@ -1,4 +1,4 @@
 // Generated by scripts/build.js from package.json. Do not edit by hand.
 export const name = "imapflow";
-export const version = "2.9.0";
+export const version = "2.10.0";
 export const homepage = "https://imapflow.com/";

package/dist/esm/types.d.ts

@@ -684,8 +684,18 @@ export interface DownloadOptions {
     chunkSize?: number | undefined;
     /** If true then requests the content with FETCH BINARY when the server supports it (BINARY or IMAP4rev2), so the server removes the transfer encoding */
     binary?: boolean | undefined;
+    /**
+     * If false then text parts are not decoded: inline `text/plain`, `text/html` and `text/x-amp-html`
+     * parts are streamed with only the transfer encoding removed, as for any other part, without
+     * unwrapping `format=flowed` lines or converting the charset to UTF-8, and `meta.charset` keeps the
+     * charset of the part. Use it to save a text part as a file. Defaults to true
+     */
+    decodeText?: boolean | undefined;
 }
-/** Options for downloadMany(): the download() options without `chunkSize`, as the parts come in one FETCH */
+/**
+ * Options for downloadMany(): the download() options without `chunkSize`, as the parts come in one FETCH, and without
+ * `decodeText`, as downloadMany() only removes the transfer encoding and never converts text
+ */
 export type DownloadManyOptions = Pick<DownloadOptions, 'uid' | 'maxBytes' | 'binary'>;
 export interface DownloadManyPart {
     meta: DownloadMeta;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "2.9.0",
+    "version": "2.10.0",
     "description": "IMAP Client for Node",
     "type": "module",
     "main": "./dist/cjs/imap-flow.js",
@@ -84,7 +84,7 @@
         "eslint-config-prettier": "10.1.8",
         "events": "3.3.0",
         "globals": "17.13.0",
-        "imapkit": "5.1.0",
+        "imapkit": "5.2.0",
         "playwright-core": "1.64.1",
         "prettier": "3.9.10",
         "process": "0.11.10",
@@ -93,23 +93,20 @@
         "tsx": "4.23.15",
         "types-node-legacy": "npm:@types/node@20.0.0",
         "typescript": "6.0.3",
-        "typescript-eslint": "8.72.0",
-        "wrangler": "4.151.3"
+        "typescript-eslint": "8.72.1",
+        "wrangler": "4.155.0"
     },
     "dependencies": {
-        "@zone-eu/mailsplit": "5.4.27",
+        "@zone-eu/mailsplit": "5.4.29",
         "encoding-japanese": "2.4.0",
         "iconv-lite": "0.7.3",
         "libbase64": "1.4.1",
-        "libmime": "5.5.2",
+        "libmime": "5.6.3",
         "libqp": "3.0.1",
         "pino": "10.3.1",
         "socks": "2.8.10"
     },
     "engines": {
         "node": ">=20.0.0"
-    },
-    "overrides": {
-        "sharp": "0.35.5"
     }
 }