\n\n**letterparser** is a parser library created for parsing e-mail messages. The library is written in TypeScript, fully supports both browser and server environments. The performance may not be the best at the current stage of development, parsing large messages is not recommended.\n\nThis library was created as an isomorphic alternative for [mailparser](https://github.com/nodemailer/mailparser).\n\nThe following RFCs are supported (or will be) by letterparser:\n\n- [RFC 5322](https://tools.ietf.org/html/rfc5322.html)\n- [RFC 6532](https://tools.ietf.org/html/rfc6532.html)\n- [RFC 2046](https://tools.ietf.org/html/rfc2046.html)\n\nParsing multipart and plain text messages is currently working, although the output is raw. A function for extracting the most commonly used data will be added in a future release.\n\n| Builder | SMTP client/server |\n| -------------------------------------------------------- | -------------------------------------------------- |\n| [letterbuilder](https://github.com/mat-sz/letterbuilder) | [@typemail/smtp](https://github.com/typemail/smtp) |\n\n## Usage\n\n> **WARNING!** [node.js built with full ICU is required](https://nodejs.org/api/intl.html). (full-icu NPM package may work as a substitute, although this is not recommended.)\n>\n> By default, recent node.js versions ship full ICU binaries. Incomplete ICU will result in bad encoding errors.\n\n### General information\n\nTo get information about the message, use `extract`:\n\n```js\nimport { extract } from 'letterparser';\nlet res = extract(`Date: Wed, 01 Apr 2020 00:00:00 -0000\nFrom: A \nTo: B \nSubject: Hello world!\nMime-Version: 1.0\nContent-Type: text/plain; charset=utf-8\n\nSome message.`);\n```\n\nThe function returns `LetterparserMail`:\n\n```ts\nexport interface LetterparserMailbox {\n name?: string;\n address: string;\n raw: string;\n}\n\nexport interface LetterparserAttachment {\n contentType: LetterparserContentType;\n body: string | Uint8Array;\n contentId?: string;\n filename?: string;\n}\n\nexport interface LetterparserMail {\n subject?: string;\n to?: LetterparserMailbox[];\n cc?: LetterparserMailbox[];\n bcc?: LetterparserMailbox[];\n from?: LetterparserMailbox;\n attachments?: LetterparserAttachment[];\n html?: string;\n text?: string;\n amp?: string;\n}\n```\n\n### Message structure\n\nThe library also exports a `parse` function that outputs the raw structure of the message.\n\n```js\nimport { parse } from 'letterparser';\nlet node = parse(`Date: Wed, 01 Apr 2020 00:00:00 -0000\nFrom: A \nTo: B \nSubject: Hello world!\nMime-Version: 1.0\nContent-Type: text/plain; charset=utf-8\n\nSome message.`);\n```\n\nThe return value of that function is `LetterparserNode`, as defined below:\n\n```ts\ninterface LetterparserContentType {\n type: string;\n encoding?: string;\n parameters: Headers;\n}\n\ninterface LetterparserNode {\n contentType: LetterparserContentType;\n headers: Headers;\n body: LetterparserNode | LetterparserNode[] | string | Uint8Array;\n}\n```\n\nHeaders names are normalized to be camel case with dashes.\n\nE.g.\n\n`Content-ID` becomes `Content-Id`\n\n`content-type` becomes `Content-Type`\n","readmeFilename":"README.md"}
![\"letterparser\"](\"https://raw.githubusercontent.com/mat-sz/letterparser/master/logo.png\"){kind=logo}
\n![\"workflow\"](\"https://img.shields.io/github/actions/workflow/status/mat-sz/letterparser/node.js.yml?branch=master\")
![\"npm\"](\"https://img.shields.io/npm/v/letterparser\")
![\"npm\"](\"https://img.shields.io/npm/dw/letterparser\")
![\"NPM\"](\"https://img.shields.io/npm/l/letterparser\")