addressparser

What is addressparser?

The addressparser npm package is used to parse email addresses into their component parts. It is particularly useful for applications that need to handle email addresses in a structured way, such as email clients, validation tools, and email processing systems.

What are addressparser's main functionalities?

Parse a single email address

This feature allows you to parse a single email address into its component parts, such as the name and the email address itself.

const addressparser = require('addressparser');
const parsed = addressparser('John Doe <[e-mail]>');
console.log(parsed);

Parse multiple email addresses

This feature allows you to parse a string containing multiple email addresses, separating each address into its component parts.

const addressparser = require('addressparser');
const parsed = addressparser('John Doe <[e-mail]>, Jane Doe <[e-mail]>');
console.log(parsed);

Handle complex email address formats

This feature allows you to handle and parse more complex email address formats, including those with special characters and quoted names.

const addressparser = require('addressparser');
const parsed = addressparser('"John Doe, PhD" <[e-mail]>, Jane Doe <[e-mail]>');
console.log(parsed);

Other packages similar to addressparser

email-addresses

The email-addresses package provides similar functionality to addressparser, allowing you to parse, validate, and manipulate email addresses. It offers more advanced parsing options and better handling of edge cases compared to addressparser.

mailparser

The mailparser package is a more comprehensive tool for parsing email messages, including headers, attachments, and body content. While it includes email address parsing as part of its functionality, it is more focused on full email message parsing rather than just addresses.

README

addressparser

Parse e-mail address fields. Input can be a single address ("[e-mail]"), a formatted address ("Andris Reinman <[e-mail]>"), comma separated list of addresses ("[e-mail], [e-mail]"), an address group ("disclosed-recipients:[e-mail];") or a mix of all the formats.

In addition to comma the semicolon is treated as the list delimiter as well (except when used in the group syntax), so a value "[e-mail]; [e-mail]" is identical to "[e-mail], [e-mail]".

Installation

Install with npm

npm install addressparser

Usage

Include the module

var addressparser = require('addressparser');

Parse some address strings with addressparser(field)

var addresses = addressparser('andris <[e-mail]>');
console.log(addresses); // [{name: "andris", address:"[e-mail]"}]

And when using groups

addressparser('Composers:"Bach, Sebastian" <[e-mail]>, [e-mail] (Mozzie);');

the result would be

[
    {
        name: "Composers",
        group: [
            {
                address: "[e-mail]",
                name: "Bach, Sebastian"
            },
            {
                address: "[e-mail]",
                name: "Mozzie"
            }
        ]
    }
]

Be prepared though that groups might be nested.

Notes

This module does not decode any mime-word or punycode encoded strings, it is only a basic parser for parsing the base data, you need to decode the encoded parts later by yourself

License

MIT