@types/mailparser

What is @types/mailparser?

@types/mailparser provides TypeScript definitions for the mailparser library, which is used to parse email messages. This package allows developers to work with email data in a structured way, making it easier to extract information such as headers, attachments, and body content.

What are @types/mailparser's main functionalities?

Parsing Email

This feature allows you to parse an email message and extract its headers, text content, and attachments. The code sample demonstrates how to set up event listeners for headers and data, and how to handle different types of data (text and attachments).

const MailParser = require('mailparser').MailParser;
const mailparser = new MailParser();

mailparser.on('headers', headers => {
  console.log(headers);
});

mailparser.on('data', data => {
  if (data.type === 'text') {
    console.log(data.text);
  } else if (data.type === 'attachment') {
    data.content.pipe(process.stdout);
  }
});

mailparser.write(emailSource);
mailparser.end();

Extracting Attachments

This feature allows you to extract attachments from an email message. The code sample demonstrates how to handle attachment data and save it to a file using a writable stream.

const MailParser = require('mailparser').MailParser;
const mailparser = new MailParser();

mailparser.on('data', data => {
  if (data.type === 'attachment') {
    data.content.pipe(fs.createWriteStream(data.filename));
  }
});

mailparser.write(emailSource);
mailparser.end();

Handling Multipart Emails

This feature allows you to handle multipart emails, which can contain both plain text and HTML content. The code sample demonstrates how to handle different types of content within a multipart email.

const MailParser = require('mailparser').MailParser;
const mailparser = new MailParser();

mailparser.on('data', data => {
  if (data.type === 'text') {
    console.log('Text:', data.text);
  } else if (data.type === 'html') {
    console.log('HTML:', data.html);
  }
});

mailparser.write(emailSource);
mailparser.end();

Other packages similar to @types/mailparser

nodemailer

Nodemailer is a module for Node.js applications to send email. While it focuses on sending emails rather than parsing them, it can be used in conjunction with mailparser to handle both sending and receiving email functionalities.

mailin

Mailin is an SMTP server that can receive emails and parse them. It provides similar parsing capabilities to mailparser but also includes the ability to act as an SMTP server, making it a more comprehensive solution for handling incoming emails.

imap

The imap package allows you to connect to an IMAP server and retrieve emails. While it does not provide parsing capabilities out of the box, it can be used to fetch emails which can then be parsed using mailparser.

README

Installation

npm install --save @types/mailparser

Summary

This package contains type definitions for mailparser (https://github.com/nodemailer/mailparser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mailparser.

Additional Details

• Last updated: Mon, 07 Oct 2024 13:41:02 GMT
• Dependencies: @types/node, iconv-lite

Credits

These definitions were written by Peter Snider, Andrey Volynkin, and Pior Błażejewicz.