npm

Check out our latest tech talk, "JavaScript Supply Chain Security" presented by VP of Security, Adam Baldwin.Watch it here »

address-rfc2821

1.1.3 • Public • Published

Build Status Dependencies Coverage Status WinCI status Greenkeeper badge

address-rfc2821

Parser for RFC2821 (Envelope) format email addresses.

This module parses RFC2821 email address from the SMTP envelope. These are the portions immediately following the SMTP verbs MAIL FROM: and RCPT TO:. RFC 2821 (and 5321) email addesses look like this:

<>             // null
<from@sender.com>
<to@sender.com>

To parse email addresses contained in the message headers (To: From: BCC, CC), look instead at an RFC 2822/5322 parser such as address-rfc2822 or email-addresses.

Installation

npm install address-rfc2821

Usage

var Address = require('address-rfc2821').Address;

var parsed = new Address('<user@example.com>');

Address Object

The Address object is an interface to reading email addresses passed in at SMTP time. It parses all the formats in RFC-2821 and 2822, as well as UTF8 email addresses according to the RFCs 5890, 5891 and 5892 providing the domain in punycode when encountered It also supports correctly escaping email addresses.

API

  • new Address (user, host)

Create a new address object for user@host

  • new Address (email)

Creates a new address object by parsing the email address. Will throw an exception if the address cannot be parsed.

  • address.user

Access the local part of the email address

  • address.host

Access the domain part of the email address, decoded if necessary to punycode

  • address.original_host

Access the domain part of the email address, unencoded and case preserved

  • address.format(use_punycode=false)

Provides the email address in the appropriate <user@host> format. And deals correctly with the null sender and local names.

If use_punycode = true, uses address.host instead of address.original_host.

  • address.toString()

Same as format().

  • address.address(newval=null, use_punycode=false)

Provides the email address in 'user@host' format.

If use_punycode = true, uses address.host instead of address.original_host.

Advanced Usage

It is possible to mess with the regular expressions used to match addresses for stricter or less strict matching.

To change the behaviour mess with the following variables:

var adr = require('address-rfc2821');
// Now change one of the following. Note they are RegExp objects NOT strings.
adr.atom_expr;
adr.address_literal_expr;
adr.subdomain_expr;
adr.domain_expr;
adr.qtext_expr;
adr.text_expr;
// Don't forget to recompile:
adr.compile_re();

License

This module is MIT licensed.

install

npm i address-rfc2821

Downloadsweekly downloads

1,819

version

1.1.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability