is_email() 项目技术文档

1. 安装指南

1.1 下载文件

首先，从项目仓库下载 is_email.php 文件。

1.2 添加到项目

将下载的 is_email.php 文件添加到你的项目目录中。

2. 项目的使用说明

2.1 基本使用

在你的 PHP 脚本中，使用 require_once 引入 is_email.php 文件，然后调用 is_email() 函数来验证电子邮件地址。

require_once 'is_email.php';

$email = '[e-mail]';
if (is_email($email)) {
    echo "$email 是一个有效的电子邮件地址";
} else {
    echo "$email 不是一个有效的电子邮件地址";
}

2.2 返回详细诊断错误代码

如果你想获取详细的诊断错误代码，可以在调用 is_email() 函数时传入额外的参数。

require_once 'is_email.php';

$email = '[e-mail]';
$result = is_email($email, true, true);

if ($result === ISEMAIL_VALID) {
    echo "$email 是一个有效的电子邮件地址";
} else if ($result < ISEMAIL_THRESHOLD) {
    echo "警告！$email 有一些不寻常的特征（结果代码 $result）";
} else {
    echo "$email 不是一个有效的电子邮件地址（结果代码 $result）";
}

2.3 示例脚本

项目中提供了一些示例脚本，位于 extras 文件夹中，你可以参考这些脚本来更好地理解如何使用 is_email() 函数。

3. 项目API使用文档

3.1 is_email() 函数

函数签名

is_email(string $email, bool $checkDNS = false, bool $diagnose = false): mixed

参数说明

• $email (string): 要验证的电子邮件地址。
• $checkDNS (bool): 是否检查电子邮件地址的 DNS 记录。默认为 false。
• $diagnose (bool): 是否返回详细的诊断错误代码。默认为 false。

返回值

• 如果 $diagnose 为 false，则返回 true 或 false，表示电子邮件地址是否有效。
• 如果 $diagnose 为 true，则返回一个整数，表示详细的诊断错误代码。

3.2 诊断错误代码

• ISEMAIL_VALID: 电子邮件地址有效。
• ISEMAIL_THRESHOLD: 警告阈值，表示电子邮件地址有一些不寻常的特征。
• 其他代码: 表示电子邮件地址无效的具体原因。

4. 项目安装方式

4.1 手动安装

1. 下载 is_email.php 文件。
2. 将文件放置在你的项目目录中。
3. 在你的 PHP 脚本中使用 require_once 引入 is_email.php 文件。

4.2 版本历史

日期	组件	版本	备注
2016-12-07	(全部)	3.0.7	语义化版本编号
2016-12-05	(全部)	3.06	将所有 http 链接更改为 https，更新了链接和版权信息，澄清了许可证
2013-11-29	tests.xml	3.05	将测试 #71 从 ISEMAIL_RFC5321 更改为 ISEMAIL_DEPREC
2013-11-29	meta.xml	3.05	将 ISEMAIL_RFC5321_IPV6DEPRECATED 的类别更改为 ISEMAIL_DEPREC
2011-07-14	tests.xml	3.04	将我的链接更改为 https://isemail.info
2011-05-23	tests.xml	3.02	tests.php: 参数不再通过引用传递（已弃用）。测试#32: 将域名更改为 c--n.com，因为 g--a.com 不再有 MX 记录。
2010-11-15	meta.xml	3.03	澄清了“Valid for numpties”的定义
2010-10-18	tests.xml	3.0	新架构设计以增强故障识别
2010-10-18	is_email.php	3.0	电子邮件有效性的法医分类

通过以上文档，你应该能够顺利安装和使用 is_email() 项目，并了解其 API 的使用方法。