masroore/mailcheck-php

减少PHP应用程序中的拼写错误电子邮件地址。

0.1.5 2023-01-15 18:03 UTC

This package is auto-updated.

Last update: 2024-09-20 17:22:21 UTC


README

当用户在电子邮件地址中拼写错误时,PHP库会建议正确的域名。查看原始代码https://github.com/mailcheck/mailcheck

当用户输入"user@gmil.con"时,Mailcheck会建议"user@gmail.com"。

Mailcheck还会提供二级和顶级域名的建议。例如,当用户输入"user@hotmail.cmo"时,会建议"hotmail.com"。同样,如果只有二级域名拼写错误,它将与顶级域名独立地进行纠正。

安装

需要 PHP 8.1+

您可以通过composer安装此包

composer require masroore/mailcheck

用法

> $mailcheck = new Kaiju\Mailcheck\Mailcheck();
> print_r($mailcheck->suggest("user@gmil.con"));

# Kaiju\Mailcheck\EmailSuggestion Object
# (
#     [fullAddress] => user@gmail.com
#     [originalAddress] => user@gmil.con
#     [account] => user
#     [domain] => gmail.com
# )

如果没有建议则返回null

> $mailcheck->suggest("user@hotmail.com")
# => null

域名

如果未提供domainssecondLevelDomainstopLevelDomains选项,Mailcheck内置了默认值。我们仍然建议根据用户的分布情况提供自己的域名。

添加自己的域名

您可以通过提供替换来替换Mailcheck的默认域名/TLD建议

$mailcheck->setDomains(['customdomain.com', 'anotherdomain.net']); // replaces existing domains
$mailcheck->setSecondLevelDomains(['domain', 'yetanotherdomain']); // replaces existing SLDs
$mailcheck->setTopLevelDomains(['com.au', 'ru']);  // replaces existing TLDs

贡献

让我们让Mailcheck变得出色。我们正在寻找维护者和贡献者

  1. 分支
  2. 创建您的功能分支(git checkout -b my-new-feature
  3. 提交您的更改(git commit -am '添加一些功能'
  4. 推送到分支(git push origin my-new-feature
  5. 创建新的Pull Request

维护者

许可证

在MIT许可证下授权。