Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

reserved-email-addresses-list

0.0.8 • Public • Published

reserved-email-addresses-list

build status code coverage code style styled with prettier made with lass license npm downloads

List of 1250+ email addresses reserved for security concerns

Table of Contents

Install

npm:

npm install reserved-email-addresses-list validator nodemailer

yarn:

yarn add reserved-email-addresses-list email-addresses

Usage

The string you are comparing with must be converted to lowercase and trimmed of whitespace. The reason we are converting to lowercase is because the dictionary of words we are comparing with are all lowercase, and in order to compare for strict equality, we must have matching case.

It is also highly recommended that you check for strict equality, and for a list of admin-related usernames, you should check for strict equality, starts with, or ends with comparisons as well.

const reservedEmailAddressesList = require('reserved-email-addresses-list');
const reservedAdminList = require('reserved-email-addresses-list/admin-list.json');
const emailAddresses = require('email-addresses');
 
const email = '"Admin***!!!"@example.com';
const parsed = emailAddresses.parseOneAddress(email);
 
if (parsed === null)
  throw new Error('Email was not a valid address');
 
const str = parsed.local.toLowerCase();
 
let reservedMatch = reservedEmailAddressesList.find(addr => addr === str);
 
if (!reservedMatch)
  reservedMatch = reservedAdminList.find(
    addr => addr === str || str.startsWith(addr) || str.endsWith(addr)
  );
 
if (reservedMatch)
  throw new Error(
    'User must be a domain admin to create an alias with a reserved word (see https://forwardemail.net/reserved-email-addresses).'
  );

List

See index.json for the complete list of all reserved email addresses, and admin-list.json for the list of all reserved admin names.

References

Contributors

Name Website
Nick Baugh http://niftylettuce.com/

License

MIT © Nick Baugh

Install

npm i reserved-email-addresses-list

DownloadsWeekly Downloads

9

Version

0.0.8

License

MIT

Unpacked Size

21.6 kB

Total Files

6

Last publish

Collaborators

  • avatar