email-bounce-parser
v1.0.22
Published
Parses bounce emails and extract errors
Downloads
29
Maintainers
Readme
Email Bounce Parser
Parses bounce emails and extracts details.
😘 Maintainer: @eliottvincent
Who uses it?
👋 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 text body (not HTML body). You can use 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: "<[email protected]>: 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: "<[email protected]> Recipient not found.",
//
// type: "action_not_taken",
//
// temporary: false,
// permanent: true,
//
// data: {
// type: "no_such_user",
// blocked: false,
// spam: false
// }
// },
//
// recipient: "[email protected]",
//
// 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.