开源项目 `reserved-email-addresses-list` 使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00094/article/details/139616826

开源项目 `reserved-email-addresses-list` 使用教程

reserved-email-addresses-list List of 1250+ generic, admin, mailer-daemon, and no-reply usernames reserved for security concerns. Made for @forwardemail. 项目地址: https://gitcode.com/gh_mirrors/re/reserved-email-addresses-list

1. 项目介绍

reserved-email-addresses-list 是一个开源项目，旨在提供一个包含1250多个通用、管理员、邮件发送者和无回复用户名的列表，这些用户名因安全原因被保留。该项目适用于需要防止用户使用特定用户名创建账户或发送邮件的场景，例如邮件服务提供商、社交媒体平台等。

该项目的主要功能包括：

提供一个包含1250多个保留用户名的列表。
支持多种格式（数组、Map、Set）的数据导出。
适用于Node.js环境，方便集成到现有项目中。

2. 项目快速启动

2.1 安装

首先，确保你已经安装了Node.js和npm。然后，通过npm安装reserved-email-addresses-list：

npm install reserved-email-addresses-list

2.2 基本使用

以下是一个简单的示例，展示如何使用reserved-email-addresses-list来检查用户名是否为保留用户名：

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');
}

2.3 使用不同格式的列表

reserved-email-addresses-list 提供了多种格式的列表，包括数组、Map和Set。以下是如何使用这些格式的示例：

// 数组格式
const reservedEmailAddressesList = require('reserved-email-addresses-list');

// Map格式
const reservedEmailAddressesMap = require('reserved-email-addresses-list/map');

// Set格式
const reservedEmailAddressesSet = require('reserved-email-addresses-list/set');