payprocessing/smtp-validate-email

通过SMTP进行电子邮件地址验证

v1.0.1 2018-08-13 10:30 UTC

This package is auto-updated.

Last update: 2024-09-18 03:07:35 UTC


README

PHP Version Software License Build Status Scrutinizer Coverage

通过SMTP进行电子邮件地址验证/验证。

SMTPValidateEmail\Validator 类检索电子邮件域的MX记录,然后连接到该域的SMTP服务器,尝试确定该地址是否真的存在。

早期版本(1.0之前)使用的是 SMTP_Validate_Email 类名(并且没有使用命名空间和其他现在常见的PHP功能)。已经注意保留旧的API,并且迁移旧代码应该不会很痛苦。请参阅“从旧版本迁移到1.0”部分。或者,只需使用/下载古老的0.7版本

功能

  • 实际上不发送消息,在完成后优雅地重置SMTP会话
  • 根据相关的RFC实现了特定命令的通信超时
  • 支持捕获所有账户检测
  • 支持批量处理模式
  • 支持日志记录/调试
  • 没有外部依赖项
  • 覆盖单元/功能测试

安装

通过 composer 安装

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

使用示例

基本示例

<?php

require 'vendor/autoload.php';

use SMTPValidateEmail\Validator as SmtpEmailValidator;

/**
 * Simple example
 */
$email     = 'someone@example.org';
$sender    = 'sender@example.org';
$validator = new SmtpEmailValidator($email, $sender);

// If debug mode is turned on, logged data is printed as it happens:
// $validator->debug = true;
$results   = $validator->validate();

var_dump($results);

// Get log data (log data is always collected)
$log = $validator->getLog();
var_dump($log);

多个收件人和其他详细信息

<?php

require 'vendor/autoload.php';

use SMTPValidateEmail\Validator as SmtpEmailValidator;

/**
 * Validating multiple addresses/recipients at once:
 * (checking multiple addresses belonging to the same server
 * uses a single connection)
 */
$emails    = [
    'someone@example.org',
    'someone.else@example.com'
];
$sender    = 'sender@example.org';
$validator = new SmtpEmailValidator($email, $sender):
$results   = $validator->validate();

var_dump($results);

/**
 * The `validate()` method accepts the same parameters
 * as the constructor, so this is equivalent to the above:
 */
$emails    = [
    'someone@example.org',
    'someone.else@example.com'
];
$sender    = 'sender@example.org';
$validator = new SmtpEmailValidator():
$results   = $validator->validate($emails, $sender);

var_dump($results);

从旧版本迁移到1.0

早期版本使用的是全局 SMTP_Validate_Email 类名。您可以在现有代码中继续使用该名称,并且仍然可以通过使用别名/导入来切换到较新(由composer驱动的)版本,如下所示

需要composer包

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

然后在您的代码中

<?php

require 'vendor/autoload.php';

use SMTPValidateEmail\Validator as SMTP_Validate_Email;

// Now any old code referencing `SMTP_Validate_Email` should still work as it did earlier

开发和贡献

请参阅Makefile,以及composer.jsonpackage.json中的开发依赖项。

在克隆(或下载)存储库后运行 make 一次会为您

Usage: make [target]

[target]                       help
--------                       ----
help                           What you're currently reading
install                        Installs dev dependencies
test                           Runs tests
coverage                       Runs tests with code coverage
$(PIDFILE)                     Starts the smtp-sink server
server-start                   Stops and starts the smtp-sink server
server-stop                    Stops smtp-sink server if it's running
clean                          Removes installed dev dependencies

因此,运行 make install 以开始。之后,您应该能够运行测试。

测试由 phpunit 和本地运行在1025端口的 smtp-sink 实例提供。如果 smtp-sink 不可用,则标记需要它的测试为跳过。

欢迎提交拉取请求!

为了使您的拉取请求合并,请遵循以下简单的规则

  • 所有代码提交都必须通过 make test 纯净地通过(没有错误)
  • 遵循现有的代码风格(使用 phpcs
  • 不应该有外部依赖项
  • 如果您想添加重要的功能/依赖项,请先提交有关该问题的请求,以便我们可以讨论添加是否适合项目

变更日志

许可协议(GPL-3.0+)