mailCheck.js 邮箱地址验证和拼写检查库

Question

mailCheck.js 是一个 JavaScript 库和 jQuery 插件，当用户在电子邮件地址中拼写错误时，就会提示一个正确的域。

当您的用户在电子邮件地址中拼错它时，mailcheck.js 它会建议正确的域名。 比如当您的用户输入 user@gmil.con 时，Mailcheck 会建议 user@gmail.com ，同样如果只有第二级域拼写错误，它将独立于顶级域进行更正。

安装

为方便使用，请下载压缩后的库。将 mailcheck.min.js 放入您的 JavaScrips 目录。mailcheck.js 也是可以使用的，如果你想修改他，或者有你自己的压缩工具。

bower install --save mailcheck
npm install --save mailcheck

和 jQuery 一起使用

首先，将 jQuery 和 Mailcheck 包含到页面中。

<script src="jquery.min.js"></script>
<script src="mailcheck.min.js"></script>

有一个文本字段。

<input id="email" name="email" type="email" />

现在，将 Mailcheck 附加到文本字段。您可以声明要检查的域、二级域和顶级域的数组。

<script>
var domains = ['gmail.com', 'aol.com'];
var secondLevelDomains = ['hotmail']
var topLevelDomains = ["com", "net", "org"];

var superStringDistance = function(string1, string2) {
  // a string distance algorithm of your choosing
}

$('#email').on('blur', function() {
  $(this).mailcheck({
    domains: domains,                       // optional
    secondLevelDomains: secondLevelDomains, // optional
    topLevelDomains: topLevelDomains,       // optional
    distanceFunction: superStringDistance,  // optional
    suggested: function(element, suggestion) {
      // callback code
    },
    empty: function(element) {
      // callback code
    }
  });
});
</script>

邮件接收了两个回调，suggested 和 empty。我们建议你方提供这两种产品。

suggested 当有建议的时候。Mailcheck 传入目标元素和建议。以下成员反对这项建议：

{
  address: 'test',          // the address; part before the @ sign
  domain: 'gmail.com',    // the suggested domain
  full: 'test@gmail.com'  // the full suggested email
}

Mailcheck 不想妨碍您如何显示建议。使用建议对象以您喜欢的方式显示建议。

empty 当没有任何建议的时候。Mailcheck 只是传入目标元素。使用这个回调来清除现有的建议是个好主意。

没有 jQuery 的用法

Mailcheck 与 jQuery 是解耦的，因此它在没有 jQuery 的情况下的用法几乎是相同的。

使用上面的示例，您可以调用 Mailcheck.run 来运行。

<script>
Mailcheck.run({
  email: yourTextInput.value,
  domains: domains,                       // optional
  topLevelDomains: topLevelDomains,       // optional
  secondLevelDomains: secondLevelDomains, // optional
  distanceFunction: superStringDistance,  // optional
  suggested: function(suggestion) {
    // callback code
  },
  empty: function() {
    // callback code
  }
});
</script>

其余的工作原理类似。事实上 Mailcheck jQuery 插件只是包装 Mailcheck.run 方法。

再 Node.js 中使用

如果您在 Node.js 上运行这个程序，您可以只需 require('mailcheck') 为了得到 mailcheck 对象，并调用 run 关于这一点：

var mailcheck = require('mailcheck');
mailcheck.run({
  // see 'usage without jQuery' above.
});

配置域名

如果 domains, secondLevelDomains 或 topLevelDomains 没有提供选择。我们仍然建议根据用户的分布提供您自己的域。

添加您自己的域

可以将 Mailcheck 的默认域建议替换为mailcheck.run：

Mailcheck.run({
  domains: ['customdomain.com', 'anotherdomain.net'], // replaces existing domains
  secondLevelDomains: ['domain', 'yetanotherdomain'], // replaces existing SLDs
  topLevelDomains: ['com.au', 'ru'] // replaces existing TLDs
});

或者你可以延展 Mailcheck 的全局默认域集和TLD，方法是将项添加到 Mailcheck.defaultDomains 和 Mailcheck.defaultTopLevelDomains：

Mailcheck.defaultDomains.push('customdomain.com', 'anotherdomain.net') // extend existing domains
Mailcheck.defaultSecondLevelDomains.push('domain', 'yetanotherdomain') // extend existing SLDs
Mailcheck.defaultTopLevelDomains.push('com.au', 'ru') // extend existing TLDs

相关链接

• WordPress 插件
• Github 地址：https://github.com/mailcheck/mailcheck