postal-mime 2.2.3 → 2.2.5

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.2.5](https://github.com/postalsys/postal-mime/compare/v2.2.4...v2.2.5) (2024-04-11)
+
+
+### Bug Fixes
+
+* **types:** Fixed Address type ([57908e4](https://github.com/postalsys/postal-mime/commit/57908e428929904ee312d9e95343a9fbf52542b4))
+
+## [2.2.4](https://github.com/postalsys/postal-mime/compare/v2.2.3...v2.2.4) (2024-04-11)
+
+
+### Bug Fixes
+
+* **exports:** Export addressParser and decodeWords functions ([43d3187](https://github.com/postalsys/postal-mime/commit/43d31873308d8eff61876f32614e5cc5143c90dd))
+
 ## [2.2.3](https://github.com/postalsys/postal-mime/compare/v2.2.2...v2.2.3) (2024-04-11)
 
 

package/README.md

@@ -123,6 +123,58 @@ This method parses an email message into a structured object with the following
     -   **attachment[].contentId** is the ID from Content-ID header
     -   **attachment[].content** is an Uint8Array value that contains the attachment file
 
+### Utility functions
+
+#### addressParser
+
+Parse email address strings
+
+```js
+addressParser(addressStr, opts) -> Array
+```
+
+where
+
+-   **addressStr** is the header value for an address header
+-   **opts** is an optional options object
+    -   **flatten** is a boolean value. If set to `true`, then ignores address groups and returns a flat array of addresses. By default (`flatten` is `false`) the result might include nested groups
+
+The result is an array of objects
+
+-   **name** is the name string. An empty string is used if name value was not set.
+-   **address** is the email address value
+-   **group** is an array of nested address objects. This is used when `flatten` is `false` (the default) and the address string contains address group syntax
+
+```js
+import { addressParser } from 'postal-mime';
+
+const addressStr = '=?utf-8?B?44Ko44Od44K544Kr44O844OJ?= <support@example.com>';
+console.log(addressParser(addressStr));
+// [ { name: 'エポスカード', address: 'support@example.com' } ]
+```
+
+#### decodeWords
+
+Decode MIME encoded-words
+
+```js
+decodeWords(encodedStr) -> String
+```
+
+where
+
+-   **encodedStr** is a string value that _may_ include MIME encoded-words
+
+The result is a unicode string
+
+```js
+import { decodeWords } from 'postal-mime';
+
+const encodedStr = 'Hello, =?utf-8?B?44Ko44Od44K544Kr44O844OJ?=';
+console.log(decodeWords(encodedStr));
+// Hello, エポスカード
+```
+
 ## License
 
 &copy; 2021-2024 Andris Reinman

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "postal-mime",
-    "version": "2.2.3",
+    "version": "2.2.5",
     "description": "Email parser for browser environments",
     "main": "./src/postal-mime.js",
     "exports": {

package/postal-mime.d.ts

@@ -3,8 +3,9 @@ export type RawEmail = string | ArrayBuffer | Uint8Array | Blob | Buffer | Reada
 export type Header = Record<string, string>;
 
 export type Address = {
-	address: string;
 	name: string;
+    address?: string;
+    group?: Address[]
 };
 
 export type Attachment = {
@@ -38,9 +39,23 @@ export type Email = {
 	attachments: Attachment[];
 };
 
+declare type AddressParserOptions = {
+    flatten?: boolean
+}
+
+declare function addressParser (
+    str: string,
+    opts?: AddressParserOptions
+): Address[];
+
+declare function decodeWords (
+    str: string
+): string;
+
 declare class PostalMime {
 	static parse(email: RawEmail): Promise<Email>;
 	parse(email: RawEmail): Promise<Email>;
 }
 
+export { addressParser, decodeWords };
 export default PostalMime;

package/src/postal-mime.js

@@ -3,6 +3,8 @@ import { textToHtml, htmlToText, formatTextHeader, formatHtmlHeader } from './te
 import addressParser from './address-parser.js';
 import { decodeWords, textEncoder, blobToArrayBuffer } from './decode-strings.js';
 
+export { addressParser, decodeWords };
+
 export default class PostalMime {
     static parse(buf) {
         const parser = new PostalMime();