Email Reply Parser

The EmailParser class is the primary entry point for extracting meaningful content from email strings. It processes the text to identify and separate the actual message from quoted replies and signatures.

When you call .parse(text), the parser:

1. Normalizes newlines.
2. Attempts to fix broken signatures using configured regex patterns.
3. Iterates through the text (processed in reverse) to identify fragments.
4. Categorizes fragments as either part of the main message, quoted text, or signatures.
5. Returns an Email object containing a collection of Fragment objects.

Fragments identified as signatures or quoted text are marked as isHidden: true.

```typescript
import EmailParser from 'email-reply-parser/lib/parser/emailparser.js';

const parser = new EmailParser();
const email = parser.parse("Your email text here...");

// The returned 'email' object contains fragments
console.log(email.fragments);
```埋

The EmailReplyParser class provides a high-level API to process email strings and separate the actual message content from quoted replies or signatures.

• read(text): Returns an EmailParser instance containing the full parsed result, allowing access to both visible and quoted text.
• parseReply(text): A convenience method that returns only the visible text (the new content added in the latest reply), stripping away quoted history.
• parseReplied(text): A convenience method that returns only the quoted text (the previous email history/replies).

import EmailReplyParser from 'email-reply-parser';

const parser = new EmailReplyParser();
const emailText = "Hello, this is my new message\n\n> This is the old quoted message";

// Get only the new message content
const visibleText = parser.parseReply(emailText);
// Output: "Hello, this is my new message"

// Get only the quoted history
const quotedText = parser.parseReplied(emailText);
// Output: "> This is the old quoted message"

// Get the full parser object for more granular control
const fullResult = parser.read(emailText);

The EmailParser uses a list of regular expressions to identify quote headers (lines that indicate the start of a quoted reply). You can customize these patterns using setQuoteHeadersRegex to adapt to specific email client behaviors.

• getQuoteHeadersRegex(): Returns the current list of regex patterns used for quote headers.
• setQuoteHeadersRegex(quoteHeadersRegex): Sets a new list of regex patterns. This method supports chaining.

Note: The parser applies these regexes to the reversed line to detect headers that typically appear at the end of a line or block.

import EmailParser from 'email-reply-parser/lib/parser/emailparser.js';

const parser = new EmailParser();

// Define custom regex patterns for quote headers
const customRegexes = [/^On .* wrote:$/, /^From: .*/];

// Set the new patterns
parser.setQuoteHeadersRegex(customRegexes);

// Parse with the new configuration
const email = parser.parse(emailText);

The Fragment class represents a specific piece of text extracted from an email during the parsing process. Each fragment carries metadata about its role within the email structure, allowing you to distinguish between the actual reply content and metadata like signatures or quoted text from previous messages.

Key properties available via methods:

• getContent(): Returns the raw string content of the fragment.
• isHidden(): Returns true if the fragment is considered hidden (e.g., part of a collapsed thread).
• isSignature(): Returns true if the fragment is identified as an email signature.
• isQuoted(): Returns true if the fragment is part of a quoted reply (the original message being replied to).
• isEmpty(): Returns true if the fragment contains no non-newline characters.
• toString(): Returns the content as a string.

// Note: Fragment is typically instantiated by the parser, not manually by the user.
// Example of how you might interact with a Fragment instance:

if (!fragment.isSignature() && !fragment.isQuoted()) {
  console.log("Actual reply content:", fragment.getContent());
}