NeahOpti/node_modules/mailparser/README.md
2025-04-22 12:49:37 +02:00

32 lines
897 B
Markdown

# mailparser
![Nodemailer](https://raw.githubusercontent.com/nodemailer/nodemailer/master/assets/nm_logo_200x136.png)
Advanced email parser for Node.js. Everything is handled as a stream which should make it able to parse even very large messages (100MB+) with relatively low overhead.
## Looking for a front-end solution?
_mailparser_ is Node.js only library, so you can't use it reliably in the front-end or bundle with WebPack. If you do need a solution to parse emails in the front-end then use [PostalMime](https://www.npmjs.com/package/postal-mime).
## Installation
First install the module from npm:
```
$ npm install mailparser
```
next import the `mailparser` object into your script:
```js
const mailparser = require('mailparser');
```
## Usage
See [mailparser homepage](https://nodemailer.com/extras/mailparser/) for documentation and terms.
### License
Licensed under MIT