Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forwardemail/reserved-email-addresses-list
List of 1250+ generic, admin, mailer-daemon, and no-reply usernames reserved for security concerns. Made for @forwardemail.
https://github.com/forwardemail/reserved-email-addresses-list
address addresses admin daemon email emails generic list local mailer no-reply parser reserved security user username
Last synced: about 1 hour ago
JSON representation
List of 1250+ generic, admin, mailer-daemon, and no-reply usernames reserved for security concerns. Made for @forwardemail.
- Host: GitHub
- URL: https://github.com/forwardemail/reserved-email-addresses-list
- Owner: forwardemail
- License: mit
- Created: 2020-01-27T06:35:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T22:05:23.000Z (5 months ago)
- Last Synced: 2024-12-15T07:05:18.124Z (7 days ago)
- Topics: address, addresses, admin, daemon, email, emails, generic, list, local, mailer, no-reply, parser, reserved, security, user, username
- Language: JavaScript
- Homepage: https://forwardemail.net/docs/reserved-email-addresses-list
- Size: 365 KB
- Stars: 155
- Watchers: 5
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# reserved-email-addresses-list
[](https://github.com/forwardemail/reserved-email-addresses-list/actions/workflows/ci.yml)
[](https://github.com/sindresorhus/xo)
[](https://github.com/prettier/prettier)
[](https://lass.js.org)
[](LICENSE)
[](https://npm.im/reserved-email-addresses-list)
> List of 1250+ generic, admin, mailer-daemon, and no-reply usernames reserved for security concerns. **Made for [Forward Email](https://forwardemail.net).**
## Table of Contents
* [Install](#install)
* [Usage](#usage)
* [Lists](#lists)
* [Formats](#formats)
* [References](#references)
* [Contributors](#contributors)
* [License](#license)
## Install
[npm][]:
```sh
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, mailer-daemon, and no-reply usernames, you should check for strict equality, starts with, or ends with comparisons as well.
```js
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).'
);
```
## Lists
* [index.json](index.json) - list of all reserved generic usernames (**includes [admin-list.json](admin-list.json) and [no-reply-list.json](no-reply-list.json)**)
* [admin-list.json](admin-list.json) - list of all reserved admin and mailer-daemon usernames (**includes [no-reply-list.json](no-reply-list.json)**)
* [no-reply-list.json](no-reply-list.json) - list of all no-reply usernames
### Formats
The default list [index.json](index.json) 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.
```js
// 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');
```
If you would like to create a Map or Set version of the other lists, simply require them first, and then convert to a `Set` or `Map` (see [map.cjs](map.cjs), [set.cjs](set.cjs), and other files in this repo for more insight how to do this).
## References
*
*
*
*
*
*
*
*
*
*
## Contributors
| Name | Website |
| -------------- | -------------------------- |
| **Nick Baugh** | |
## License
[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)
##
[npm]: https://www.npmjs.com/