postal-mime 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [2.2.0](https://github.com/postalsys/postal-mime/compare/v2.1.2...v2.2.0) (2024-03-26)
+
+
+### Features
+
+* **interface:** Added statis parse() method to simplify usage (`await PostalMime.parse(email)`) ([c2faa27](https://github.com/postalsys/postal-mime/commit/c2faa276520d6551df640abe008986eebc6d99d3))
+
+## [2.1.2](https://github.com/postalsys/postal-mime/compare/v2.1.1...v2.1.2) (2024-02-29)
+
+
+### Bug Fixes
+
+* **git:** re-renamed git repo ([29d235e](https://github.com/postalsys/postal-mime/commit/29d235ece222844dc59858d9e991cc85f65733e2))
+* **git:** Renamed git repository ([829e537](https://github.com/postalsys/postal-mime/commit/829e5371602f87fe114d87130c6e9953d50872b4))
+
 ## [2.1.1](https://github.com/postalsys/postal-mime/compare/v2.1.0...v2.1.1) (2024-02-26)
 
 

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021-2023 Andris Reinman
+Copyright (c) 2021-2024 Andris Reinman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,12 @@
 # postal-mime
 
-Email parser for browser environments.
+Email parser for browser and serverless environments.
 
-PostalMime can be run in the main web thread or from Web Workers.
+PostalMime can be run in the main web thread or from Web Workers. It can also used in serverless functions.
 
 ## Source
 
-Source code is available from [Github](https://github.com/postalsys/postal-mime).
+The source code is available from [Github](https://github.com/postalsys/postal-mime).
 
 ## Demo
 
@@ -14,7 +14,7 @@ See this [example](https://kreata.ee/postal-mime/example/).
 
 ## Usage
 
-First install the module from npm:
+First, install the module from npm:
 
 ```
 $ npm install postal-mime
@@ -26,7 +26,7 @@ next import the PostalMime class into your script:
 import PostalMime from './node_modules/postal-mime/src/postal-mime.js';
 ```
 
-or when using from a Node.js app
+or when using from a Node.js app or in a serverless function:
 
 ```js
 import PostalMime from 'postal-mime';
@@ -34,15 +34,14 @@ import PostalMime from 'postal-mime';
 
 ### Promises
 
-All postal-mime methods use Promises, so you need to wait using `await` or wait for the `then()` method to fire until you get the response.
+PostalMime methods use Promises, so you need to wait using `await` or wait for the `then()` method to fire until you get the response.
 
 #### Browser
 
 ```js
 import PostalMime from './node_modules/postal-mime/src/postal-mime.js';
 
-const parser = new PostalMime();
-const email = await parser.parse(`Subject: My awesome email 🤓
+const email = await PostalMime.parse(`Subject: My awesome email 🤓
 Content-Type: text/html; charset=utf-8
 
 <p>Hello world 😵‍💫</p>`);
@@ -58,8 +57,7 @@ It is pretty much the same as in the browser.
 import PostalMime from 'postal-mime';
 import util from 'node:util';
 
-const parser = new PostalMime();
-const email = await parser.parse(`Subject: My awesome email 🤓
+const email = await PostalMime.parse(`Subject: My awesome email 🤓
 Content-Type: text/html; charset=utf-8
 
 <p>Hello world 😵‍💫</p>`);
@@ -76,8 +74,7 @@ import PostalMime from 'postal-mime';
 
 export default {
     async email(message, env, ctx) {
-        const parser = new PostalMime();
-        const email = await parser.parse(message.raw);
+        const email = await PostalMime.parse(message.raw);
 
         console.log('Subject: ', email.subject);
         console.log('HTML: ', email.html);
@@ -86,17 +83,17 @@ export default {
 };
 ```
 
-#### parser.parse()
+#### PostalMime.parse()
+
+`parse(email)` is a static class method to parse emails
 
 ```js
-parser.parse(email) -> Promise
+PostalMime.parse(email) -> Promise
 ```
 
 Where
 
--   **email** is the rfc822 formatted email. Either a string, an ArrayBuffer, a Blob object or a Node.js Buffer
-
-> **NB** you can call `parse()` only once. If you need to parse another message, create a new _PostalMime_ object.
+-   **email** is the rfc822 formatted email. Either a string, an ArrayBuffer/Uint8Array value, a Blob object, a Node.js Buffer, or a [ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
 
 This method parses an email message into a structured object with the following properties:
 
@@ -121,10 +118,10 @@ This method parses an email message into a structured object with the following
     -   **attachment[].disposition** is either "attachment", "inline" or `null` if disposition was not provided
     -   **attachment[].related** is a boolean value that indicats if this attachment should be treated as embedded image
     -   **attachment[].contentId** is the ID from Content-ID header
-    -   **attachment[].content** is an ArrayBuffer that contains the attachment file
+    -   **attachment[].content** is an Uint8Array value that contains the attachment file
 
 ## License
 
-&copy; 2021-2023 Andris Reinman
+&copy; 2021-2024 Andris Reinman
 
 `postal-mime` is licensed under the **MIT No Attribution license**

package/package.json

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

package/src/postal-mime.js

@@ -4,6 +4,11 @@ import addressParser from './address-parser.js';
 import { decodeWords, textEncoder, blobToArrayBuffer } from './decode-strings.js';
 
 export default class PostalMime {
+    static parse(buf) {
+        const parser = new PostalMime();
+        return parser.parse(buf);
+    }
+
     constructor() {
         this.root = this.currentNode = new MimeNode({
             postalMime: this