SMTP_Validate_Email 项目技术文档

1. 安装指南

1.1 使用 Composer 安装

该项目推荐使用 Composer 进行安装。Composer 是 PHP 的依赖管理工具，能够帮助你轻松管理项目的依赖关系。

安装步骤：

1. 确保你已经安装了 Composer。如果尚未安装，请参考 Composer 官方文档 进行安装。

2. 在你的项目根目录下运行以下命令来安装 SMTP_Validate_Email：

   composer require zytzagoo/smtp-validate-email --update-no-dev
   

3. 安装完成后，Composer 会自动将依赖包下载到 vendor 目录中，并在 composer.json 文件中添加相应的依赖项。

1.2 手动安装

如果你不使用 Composer，也可以手动下载项目源码并将其放置在你的项目目录中。不过，这种方式不推荐，因为它会增加维护成本。

2. 项目的使用说明

2.1 基本使用

以下是一个简单的使用示例，展示了如何验证单个电子邮件地址：

<?php

require 'vendor/autoload.php';

use SMTPValidateEmail\Validator as SmtpEmailValidator;

$email     = '[e-mail]';
$sender    = '[e-mail]';
$validator = new SmtpEmailValidator($email, $sender);

// 如果需要调试模式，可以打开调试日志
// $validator->debug = true;

$results   = $validator->validate();

var_dump($results);

// 获取日志数据
$log = $validator->getLog();
var_dump($log);

2.2 验证多个电子邮件地址

你也可以一次性验证多个电子邮件地址：

<?php

require 'vendor/autoload.php';

use SMTPValidateEmail\Validator as SmtpEmailValidator;

$emails    = [
    '[e-mail]',
    '[e-mail]'
];
$sender    = '[e-mail]';
$validator = new SmtpEmailValidator($emails, $sender);
$results   = $validator->validate();

var_dump($results);

2.3 迁移到 1.0 版本

如果你是从旧版本迁移到 1.0 版本，可以通过以下方式保持兼容性：

<?php

require 'vendor/autoload.php';

use SMTPValidateEmail\Validator as SMTP_Validate_Email;

// 旧代码中引用的 `SMTP_Validate_Email` 类名仍然有效

3. 项目 API 使用文档

3.1 SMTPValidateEmail\Validator 类

构造函数

public function __construct(array|string $emails = null, string $sender = null, array $options = [])

• $emails：要验证的电子邮件地址，可以是单个字符串或数组。
• $sender：发送者的电子邮件地址。
• $options：可选参数，用于配置验证器的行为。

validate() 方法

public function validate(array|string $emails = null, string $sender = null)

• $emails：要验证的电子邮件地址，可以是单个字符串或数组。
• $sender：发送者的电子邮件地址。

该方法返回一个关联数组，键为电子邮件地址，值为验证结果（true 或 false）。

getLog() 方法

public function getLog()

返回验证过程中生成的日志数据。

3.2 调试模式

你可以通过设置 debug 属性来启用调试模式：

$validator->debug = true;

启用后，验证过程中的日志数据会实时打印出来。

4. 项目安装方式

4.1 使用 Composer 安装

如前所述，推荐使用 Composer 进行安装：

composer require zytzagoo/smtp-validate-email --update-no-dev

4.2 手动安装

如果你不使用 Composer，可以手动下载项目源码并将其放置在你的项目目录中。不过，这种方式不推荐，因为它会增加维护成本。

5. 开发与贡献

如果你希望为该项目做出贡献，可以参考以下步骤：

1. 克隆或下载项目仓库。
2. 运行 make install 安装开发依赖。
3. 运行 make test 进行测试。

贡献代码时，请确保遵循以下规则：

• 所有代码提交必须通过 make test 测试。
• 遵循现有的代码风格。
• 不要引入外部依赖。
• 如果需要添加重要功能或依赖，请先提交 issue 进行讨论。

6. 许可证

该项目采用 GPL-3.0+ 许可证。详细信息请参阅 LICENSE.txt 文件。