Package Exports

email-bounce-parser
email-bounce-parser/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (email-bounce-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Email Bounce Parser

Parses bounce emails and extracts details.

😘 Maintainer: @eliottvincent

Who uses it?

Crisp

👋 You use this library and you want to be listed there? Contact us.

Features

This library is used at Crisp everyday to parse bounce emails. It supports most variations of bounce emails (Postfix, Dovecat, Gmail, Outlook).

Usage

const EmailBounceParse = require("email-bounce-parser");

const result = new EmailBounceParse().read(MY_EMAIL_STRING);

console.log(result);

API

Parse a bounce email

read(body) parses the bounce email and extracts available information (error code and type, server, original recipient, etc.):

body must be a string representing the bounce email body (as returned by mailparser, for example)

const EmailBounceParse = require("email-bounce-parser");

const result = new EmailBounceParse().read(MY_EMAIL_STRING);

console.log(result);
// {
//   bounce: true,
//
//   email: {
//     body: "This is the mail system at host mailer.acme.email [...] (in reply to RCPT TO command)",
//     intro: "This is the mail system at host mailer.acme.email [...] The mail system",
//     error: "<support@yipee.com>: host smtp.secureserver.net[92.240.81.0] said: [...] (in reply to RCPT TO command)"
//   },
//
//   data: {
//     error: {
//       code: {
//         basic: "550",
//         enhanced: "5.1.1"
//       },
//       label: "<support@yipee.com> Recipient not found.",
//
//       type: "action_not_taken",
//
//       temporary: false,
//       permanent: true,
//
//       data: {
//         type: "no_such_user",
//       }
//     },
//
//     server: {
//       hostname: "smtp.secureserver.net",
//       ip: "92.240.81.0",
//       port: "25"
//     },
//
//     command: "RCPT TO"
//   }
// }

Head over to /test/fixtures/ for more bounce examples and parsing results (anonymized data).

Contributing

Feel free to fork this project and submit fixes. We may adapt your code to fit the codebase.

You can run unit tests using:

npm test

License

email-bounce-parser is released under the MIT License. See the bundled LICENSE file for details.