Verimail.js 技术文档

1. 安装指南

在开始使用 Verimail.js 前，您需要确保您的项目中已经包含了 JavaScript 环境。以下是安装 Verimail.js 的步骤：

• 下载 Verimail.js 的最新版本。
• 将下载的文件添加到您的项目目录中。

或者，如果您希望使用 jQuery 插件版本（verimail.jquery.js），请确保您已经包含了 jQuery 库。

2. 项目使用说明

Verimail.js 是一个用于验证电子邮件地址的 JavaScript 工具包，可以预防许多常见的输入错误。目前支持以下功能：

• 语法验证（按照 RFC 822 标准）
• IANA 顶级域名验证
• 对于最常见的顶级域名和电子邮件域名提供拼写建议
• 拒绝临时电子邮件账户域名，如 mailinator.com

例如，验证 '[e-mail]' 将会得到一个拼写建议：

您是不是想输入 [e-mail]？

jQuery 示例（verimail.jquery.js）

$("input#email-address").verimail({
    messageElement: "p#status-message"
});

普通示例（verimail.js）

var email = "[e-mail]";
var verimail = new Comfirm.AlphaMail.Verimail();

verimail.verify(email, function(status, message, suggestion){
    if(status < 0){
        // 输入的语法不正确！
        if(suggestion){
            // 但是我们可能有解决方案！
            console.log("您是不是想输入 " + suggestion + "？");
        }
    }else{
        // 语法看起来很棒！
        if(suggestion){
            // 但是我们猜测您可能拼写错误了
            console.log("您是不是想输入 " + suggestion + "？");
        }
    }
});

3. 项目 API 使用文档

Verimail.js 提供了简单的 API 以供开发者使用：

• verify(email, callback): 验证指定的电子邮件地址。email 是要验证的电子邮件地址字符串，callback 是验证完成后的回调函数，该函数包含三个参数：状态码 status、状态消息 message 和拼写建议 suggestion。

4. 项目安装方式

要安装 Verimail.js，您可以通过以下方式：

• 手动下载：访问 Verimail.js 的 GitHub 仓库或官方网站，下载最新版本的源代码，并将其添加到您的项目中。
• npm 安装：在命令行中运行以下命令来使用 npm 安装：

npm install verimail.js

请注意，以上指南假设您具有一定的前端开发经验，并且熟悉 JavaScript 及其生态系统。在使用 Verimail.js 时，请确保遵循上述安装和使用说明。