postal-mime 2.2.9 → 2.3.2

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [2.3.2](https://github.com/postalsys/postal-mime/compare/v2.3.1...v2.3.2) (2024-09-23)
+
+
+### Bug Fixes
+
+* Modified README to trigger a new release (previous npm publish failed) ([f975ef4](https://github.com/postalsys/postal-mime/commit/f975ef4bc8403af72d8cd25ee2d4b3a12cdf82e4))
+
+## [2.3.1](https://github.com/postalsys/postal-mime/compare/v2.3.0...v2.3.1) (2024-09-23)
+
+
+### Bug Fixes
+
+* **message/rfc822:** Added option 'forceRfc822Attachments' to handle all message/rfc822 nodes as attachments instead of inline content ([bf47621](https://github.com/postalsys/postal-mime/commit/bf47621da7c55a31acb39fb505f415b1ed4ce5e2))
+
+## [2.3.0](https://github.com/postalsys/postal-mime/compare/v2.2.9...v2.3.0) (2024-09-23)
+
+
+### Features
+
+* Treat message/rfc822 as an attachment for delivery-status and feedback-report ([21e6224](https://github.com/postalsys/postal-mime/commit/21e62245aeb416b921ba683dd8628f5948831c56))
+
 ## [2.2.9](https://github.com/postalsys/postal-mime/compare/v2.2.8...v2.2.9) (2024-09-16)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 Email parser for browser and serverless environments.
 
-PostalMime can be run in the main web thread or from Web Workers. It can also be used in serverless functions.
+PostalMime can be run in the main web thread or from Web Workers. It can also be used in serverless functions like Cloudflare Email Workers.
 
 > [!TIP]
 > PostalMime is developed by the makers of **[EmailEngine](https://emailengine.app/?utm_source=github&utm_campaign=imapflow&utm_medium=readme-link)** – a self-hosted email gateway that allows making **REST requests against IMAP and SMTP servers**. EmailEngine also sends webhooks whenever something changes on the registered accounts.
@@ -98,7 +98,8 @@ Where:
 
 -   **email**: The RFC822 formatted email. This can be a string, an ArrayBuffer/Uint8Array, a Blob object, a Node.js Buffer, or a [ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream).
 -   **options**: An optional object containing configuration options.
-    -   **rfc822Attachments**: A boolean (defaults to `false`). If set to `true`, it treats `Message/RFC822` attachments without a Content-Disposition declaration as attachments. By default, these messages are treated as inline values.
+    -   **rfc822Attachments**: A boolean (defaults to `false`). If set to `true`, then treats `message/rfc822` attachments without a Content-Disposition declaration as attachments. By default, these messages are treated as inline values.
+    -   **forceRfc822Attachments**: A boolean (defaults to `false`). If set to `true`, then treats all `message/rfc822` nodes as attachments.
 
 This method parses an email message into a structured object with the following properties:
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "postal-mime",
-    "version": "2.2.9",
+    "version": "2.3.2",
     "description": "Email parser for browser environments",
     "main": "./src/postal-mime.js",
     "exports": {
@@ -28,7 +28,7 @@
     "author": "Andris Reinman",
     "license": "MIT-0",
     "devDependencies": {
-        "@types/node": "22.5.5",
+        "@types/node": "22.6.0",
         "cross-blob": "3.0.2",
         "cross-env": "7.0.3",
         "eslint": "8.57.0",

package/postal-mime.d.ts

@@ -53,7 +53,8 @@ declare function decodeWords (
 ): string;
 
 declare type PostalMimeOptions = {
-    rfc822Attachments?: boolean
+    rfc822Attachments?: boolean,
+    forceRfc822Attachments?: boolean
 }
 
 declare class PostalMime {

package/src/postal-mime.js

@@ -123,15 +123,15 @@ export default class PostalMime {
         let textTypes = new Set();
         let textMap = (this.textMap = new Map());
 
+        let forceRfc822Attachments = this.forceRfc822Attachments();
+
         let walk = async (node, alternative, related) => {
             alternative = alternative || false;
             related = related || false;
 
             if (!node.contentType.multipart) {
-                // regular node
-
                 // is it inline message/rfc822
-                if (this.isInlineMessageRfc822(node)) {
+                if (this.isInlineMessageRfc822(node) && !forceRfc822Attachments) {
                     const subParser = new PostalMime();
                     node.subMessage = await subParser.parse(node.content);
 
@@ -168,9 +168,6 @@ export default class PostalMime {
                 // is it text?
                 else if (this.isInlineTextNode(node)) {
                     let textType = node.contentType.parsed.value.substr(node.contentType.parsed.value.indexOf('/') + 1);
-                    if (node.contentType.parsed.value === 'message/delivery-status') {
-                        textType = 'plain';
-                    }
 
                     let selectorNode = alternative || node;
                     if (!textMap.has(selectorNode)) {
@@ -218,13 +215,6 @@ export default class PostalMime {
                             break;
                         }
 
-                        case 'message/delivery-status': {
-                            // Enforce into unicode
-                            const decodedText = node.getTextContent().replace(/\r?\n/g, '\n').replace(/\n*$/, '\n');
-                            attachment.content = textEncoder.encode(decodedText);
-                            break;
-                        }
-
                         // Regular attachments
                         default:
                             attachment.content = node.content;
@@ -330,8 +320,6 @@ export default class PostalMime {
         switch (node.contentType.parsed.value) {
             case 'text/html':
             case 'text/plain':
-            // message/delivery-status is cast into regular plaintext content
-            case 'message/delivery-status':
                 return true;
 
             case 'text/calendar':
@@ -349,6 +337,28 @@ export default class PostalMime {
         return disposition === 'inline';
     }
 
+    // Check if this is a specially crafted report email where message/rfc822 content should not be inlined
+    forceRfc822Attachments() {
+        if (this.options.forceRfc822Attachments) {
+            return true;
+        }
+
+        let forceRfc822Attachments = false;
+        let walk = node => {
+            if (!node.contentType.multipart) {
+                if (['message/delivery-status', 'message/feedback-report'].includes(node.contentType.parsed.value)) {
+                    forceRfc822Attachments = true;
+                }
+            }
+
+            for (let childNode of node.childNodes) {
+                walk(childNode);
+            }
+        };
+        walk(this.root);
+        return forceRfc822Attachments;
+    }
+
     async resolveStream(stream) {
         let chunkLen = 0;
         let chunks = [];