Nimble Polyglot Microcosm

    reserved-email-addresses-list

    1.0.2 • Public • Published

    reserved-email-addresses-list

    build status 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 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).'
      );

    Formats

    The list itself comes in a few different formats. The default import is an Array, but also available are a Map and Set version of the list.

    // Array version
    const reservedEmailAddressesList = require('reserved-email-addresses-list');
    // Also available with: require('reserved-email-addresses-list/array');
    
    // Map version
    const reservedEmailAddressesMap = require('reserved-email-addresses-list/map');
    
    // Set version
    const reservedEmailAddressesSet = require('reserved-email-addresses-list/set');

    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

    33

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    23.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • niftylettuce
    • titanism