```
--------------------------------
### Equivalent MailParser and simpleParser Options
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/configuration.md
Demonstrates that both MailParser and simpleParser accept the same core configuration options for consistency.
```javascript
// These are equivalent
const parser = new MailParser({
checksumAlgo: 'sha256',
skipTextLinks: true
});
const mail = await simpleParser(input, {
checksumAlgo: 'sha256',
skipTextLinks: true
});
```
--------------------------------
### Promise-based Parsing with simpleParser
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/api-reference/simpleparser.md
Demonstrates how to use simpleParser with Promises to parse email content from a file stream, Buffer, or string. This is the recommended approach.
```javascript
const fs = require('fs');
const { simpleParser } = require('mailparser');
// From file stream
const mail = await simpleParser(fs.createReadStream('email.eml'));
console.log('Subject:', mail.subject);
console.log('From:', mail.from?.text);
console.log('Text:', mail.text);
// From Buffer
const buffer = fs.readFileSync('email.eml');
const mail = await simpleParser(buffer);
// From string
const emailString = fs.readFileSync('email.eml', 'utf8');
const mail = await simpleParser(emailString);
```
--------------------------------
### Get and Format Date Header
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/QUICK_START.md
Access the 'date' header from parsed email content, which is returned as a JavaScript Date object. Format the date using methods like toISOString() and toUTCString().
```javascript
const mail = await simpleParser(input);
console.log(mail.date); // Date object
console.log(mail.date.toISOString());
console.log(mail.date.toUTCString());
```
--------------------------------
### Parse Email with All Options
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/README.md
Demonstrates advanced usage of simpleParser with various options to control content handling, security, performance, and custom formatting. This allows fine-grained control over the parsing process.
```javascript
const { simpleParser } = require('mailparser');
const mail = await simpleParser(emailStream, {
// Content handling
skipHtmlToText: false,
skipTextToHtml: false,
skipTextLinks: false,
skipImageLinks: false,
// Security/performance
checksumAlgo: 'sha256',
maxHtmlLengthToParse: 5 * 1024 * 1024,
// Custom formatting
formatDateString: (date) => date.toISOString()
});
console.log(mail.subject);
console.log(mail.from?.text);
console.log(mail.text);
console.log(mail.html);
mail.attachments.forEach(att => {
console.log(`${att.filename}: ${att.size} bytes, ${att.checksum}`);
});
```
--------------------------------
### Accessing and Iterating Headers
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/types.md
Demonstrates how to access the headers Map, retrieve specific header values, and iterate over all header entries.
```javascript
const headers = parser.headers; // or mail.headers in simpleParser
// Get single value
const subject = headers.get('subject');
// Get all entries
for (const [key, value] of headers) {
console.log(key, value);
}
// Check if key exists
if (headers.has('message-id')) {
const msgId = headers.get('message-id');
}
```
--------------------------------
### Parse Email with Configuration Options
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/QUICK_START.md
Customize the parsing behavior using configuration options with simpleParser. Options include skipping HTML to text conversion, linkification, and attachment checksum algorithms.
```javascript
const mail = await simpleParser(input, {
skipHtmlToText: false, // Generate text from HTML if missing
skipTextToHtml: false, // Generate HTML from text if missing
skipTextLinks: false, // Linkify URLs
skipImageLinks: false, // Convert CID images to data URLs
checksumAlgo: 'sha256', // Use SHA-256 for attachments
maxHtmlLengthToParse: 10*1024*1024 // 10MB HTML limit
});
```
--------------------------------
### Import MailParser and simpleParser
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/README.md
Import the necessary classes and functions from the mailparser library.
```javascript
const { MailParser, simpleParser } = require('mailparser');
```
--------------------------------
### Handle Image CID Links
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/configuration.md
Configure how `cid:` references in HTML are handled, either by converting them to data URLs or keeping them as references.
```javascript
// Default behavior (convert CID to data URL)
const mail1 = await simpleParser(email);
// 
// Keep CID references
const mail2 = await simpleParser(email, {
keepCidLinks: true
});
// 
```
Set `keepCidLinks: true` to preserve original `cid:` references.
### HTML to Text Conversion
When `text` is not present but `html` is, plaintext is automatically generated from HTML unless `skipHtmlToText: true`.
### Text to HTML Conversion
When `html` is not present but `text` is, HTML is automatically generated from plaintext unless `skipTextToHtml: true`.
### Text Linkification
URLs and email addresses in plaintext are automatically converted to HTML links unless `skipTextLinks: true`.
```
--------------------------------
### Address Object Structure
Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/api-reference/simpleparser.md
Illustrates the structure of address objects returned by simpleParser for email headers. This includes the 'value' array, and 'html' and 'text' representations.
```javascript
{
value: [
{
name?: string, // Display name
address: string // Email address
}
],
html: string, // HTML formatted addresses
text: string // Plain text formatted addresses
}
```
```javascript
mail.from.value = [
{ name: 'John Doe', address: 'john@example.com' }
];
mail.from.text = '"John Doe" ` tags. 4. Converts multiple newlines to `
` breaks.
5. Converts single newlines to `
` tags.
### Linkification
Uses the `linkify-it` library with support for full TLD lists, Twitter mentions, fuzzy detection, and Git protocols.
### Security
- URL quotes are escaped in `href` attributes.
- Email addresses are HTML-encoded.
- Content is properly escaped for HTML.
### Example
```javascript
const text = 'Check out https://example.com\n\nThis is a new paragraph';
parser.textToHtml(text);
//
Check out https://example.com
This is a new paragraph
``` ``` -------------------------------- ### Configure Mailparser for High Volume Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/configuration.md Reuse parser configuration for high-volume processing by setting specific options like checksum algorithm and skipping certain content types. ```javascript const { MailParser } = require('mailparser'); // Reuse parser configuration const options = { checksumAlgo: 'md5', // Faster than SHA skipTextLinks: true, skipImageLinks: true, skipTextToHtml: true }; // For each email const parser = new MailParser(options); // ... process ``` -------------------------------- ### Promise-Based Error Handling with try-catch Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/errors.md Use a try-catch block when using `simpleParser` to handle potential errors during parsing. Differentiate between common error types like TypeError for invalid input or 'ENOENT' for file not found. ```javascript const { simpleParser } = require('mailparser'); try { const mail = await simpleParser(input, options); console.log('Parsed:', mail.subject); } catch (err) { if (err instanceof TypeError) { console.error('Invalid input:', err.message); } else if (err.code === 'ENOENT') { console.error('File not found'); } else { console.error('Parse error:', err.message); } } ``` -------------------------------- ### getAddressesText Source: https://github.com/nodemailer/mailparser/blob/master/_autodocs/api-reference/header-processing.md Formats an array of address objects into a plain text string. ```APIDOC ## getAddressesText(value) ### Description Formats an array of address objects into a plain text string. ### Method `getAddressesText(value: array): string` ### Parameters #### Path Parameters - **value** (array) - Required - Array of address objects, where each object can have `name` and `address` properties. ### Returns A string containing plain text formatted addresses. ### Format - With name: `"John Doe"