README

在 PHP 中验证电子邮件地址的最简单方式。

先决条件

要使用此库，您需要创建一个免费的电子邮件验证账户： https://emailverification.whoisxmlapi.com/

如果您还没有这样做，请现在就做。

安装

要使用 composer 安装 email-verifier，只需运行

$ composer require whois-api/email-verifier

在您的项目目录根目录下。

要使用库，使用 Composer 的 自动加载

require_once __DIR__ . "/vendor/autoload.php";

要求

支持的 PHP 版本

• PHP 5.6.x
• PHP 7.0.x
• PHP 7.1.x
• PHP 7.2.x

依赖关系

• mbstring
• mbregex
• json
• curl

文档

完整的 API 文档可在 此处 获取

用法

安装 email-verifier 后，您可以使用它轻松验证电子邮件地址。电子邮件验证执行多项检查以确保给定的电子邮件地址确实是有效的。

此库为您提供了所有类型的电子邮件验证数据，您可以在应用程序中以多种方式使用这些数据。

<?php
require_once  __DIR__ . '/../vendor/autoload.php';

use WhoisApi\EmailVerifier\Builders\ClientBuilder;


$builder = new ClientBuilder();

$client = $builder->build('Your API key');

try {
    echo $client->getRawData('support@whoisxmlapi.com', 'json') . PHP_EOL;
    /* Disable refreshing */
    echo print_r($client->get('support@whoisxmlapi.com', ['_hardRefresh']), true) . PHP_EOL;
    
    $result = $client->get('support@whoisxmlapi.com', ['_hardRefresh']);
    echo 'Email: ' . $result->emailAddress . PHP_EOL;
    echo 'Format: ' . ($result->formatCheck ? 'valid' : 'invalid') . PHP_EOL;
    echo 'DNS: '. ($result->dnsCheck ? 'resolved' : 'not resolved') . PHP_EOL;
    echo 'SMTP: ' . ($result->smtpCheck ? 'working' : 'not working') . PHP_EOL;
    echo 'Free: ' . ($result->freeCheck ? 'yes' : 'no') . PHP_EOL;
    echo 'Catch all: ' . ($result->catchAllCheck ? 'yes' : 'no') . PHP_EOL;
    echo 'Disposable: ' . ($result->disposableCheck ? 'yes' : 'no') . PHP_EOL;
} catch (\Throwable $exception) {
    echo "Error: {$exception->getCode()} {$exception->getMessage()}" . PHP_EOL;
}

更多示例请参阅 "examples" 目录。

在运行这些示例之前，您需要将 API 密钥指定为环境变量

export API_KEY="<Your-API-key>"

php examples/basic.php

以下是执行电子邮件验证请求时可能返回的数据类型

{
  "emailAddress": "support@whoisxmlapi.com",
  "formatCheck": "true",
  "smtpCheck": "true",
  "dnsCheck": "true",
  "freeCheck": "false",
  "disposableCheck": "false",
  "catchAllCheck": "true",
  "mxRecords": [
    "ALT1.ASPMX.L.GOOGLE.com",
    "ALT2.ASPMX.L.GOOGLE.com",
    "ASPMX.L.GOOGLE.com",
    "ASPMX2.GOOGLEMAIL.com",
    "ASPMX3.GOOGLEMAIL.com",
    "mx.yandex.net"
  ],
  "audit": {
    "auditCreatedDate": "2018-04-19 18:12:45.000 UTC",
    "auditUpdatedDate": "2018-04-19 18:12:45.000 UTC"
  }
}

开发

在克隆此存储库后，您需要安装所有要求

$ composer install

要运行测试，可以使用以下命令

$ composer run-script test