mygit/ghost/parse-email-address/README.md

Parse Email Address

Extract the local and domain parts of email address strings.

Usage

parseEmailAddress('foo@example.com');
// => {local: 'foo', domain: 'example.com'}

parseEmailAddress('invalid');
// => null

parseEmailAddress('foo@中文.example');
// => {local: 'foo', domain: 'xn--fiq228c.example'}

• Domain names must have at least two labels. example.com is okay, example is not.
• The top level domain must have at least two octets. example.com is okay, example.x is not.
• There are various length limits:
  • The whole email is limited to 986 octets, per SMTP.
  • Domain names are limited to 253 octets, per SMTP.
  • Domain labels are limited to 63 octets, per DNS.

Develop

This is a monorepo package.

Follow the instructions for the top-level repo.

1. git clone this repo & cd into it as usual
2. Run pnpm to install top-level dependencies.

Test

• pnpm lint run just eslint
• pnpm test run lint and tests