README

为 Laravel 5 定制的 PHP 库 - 由 ngunyimacharia 开发

该包为 Laravel 网络应用程序提供了验证邮箱的简单接口。该包提供了一种简单的方法来检查电子邮件是否有效。此外，返回的响应经过过滤，提供格式化数据以便用户渲染。这使得快速验证电子邮件同时使代码更加全面。

> 发帖前注意：在为该包发布问题之前，请确保尽可能提供有关请求的详细信息。

安装

通过 Composer 拉取此包。


    {
        "require": {
            "mashytski/trumail": "dev-master"
        }
    }

或者在终端运行： composer require mashytski/trumail

Laravel 5.5+ 集成

Laravel 的包发现将为您处理集成。

Laravel 5.* 集成

将服务提供者添加到您的 config/app.php 文件


    'providers'     => array(

        //...
        Mashytski\Trumail\TrumailServiceProvider::class,

    ),

将外观添加到您的 config/app.php 文件


    'aliases'       => array(

        //...
        'Trumail'          => Mashytski\Trumail\Facades\Trumail::class,

    ),

Laravel 4.* 集成

将服务提供者添加到您的 app/config/app.php 文件


    'providers'     => array(

        //...
        'Mashytski\Trumail\TrumailServiceProvider',

    ),

将外观添加到您的 app/config/app.php 文件


    'facades'       => array(

        //...
        'Trumail'          => 'Mashytski\Trumail\Facades\Trumail',

    ),

用法

.env 配置

为了使用 Trumail API，需要有一个令牌。要获取令牌，请注册账户。

获取令牌后，将其添加到您的 .env 文件中。如果您没有 .env 文件，您可以通过复制 .env.example 文件来创建一个。


    TRUMAIL_TOKEN = YOUR_TRUMAIL_TOKEN_HERE

邮箱验证

为了验证电子邮件地址，您需要使用包中提供的 validate() 方法


    use Mashytski\Trumail\Facades\Trumail;

    // Validate email
    $response = Trumail::validate('email@example.com');

验证响应

默认情况下，Trumail::validate() 方法将始终返回一个 TrumailResponse 对象。

以下是预期响应

1. 提供了无效的 API 令牌

TrumailResponse {
   status: 403
   "error": "Invalid API token/key"
}

2. 提供了无效的电子邮件


TrumailResponse {
  status: 200
  "isValid": false
  "invalid_reason": "Email address not deliverable"
}

3. 提供了有效的电子邮件


TrumailResponse {
  status: 200
  "isValid": true
}

测试

该包使用 PHPUNIT 进行测试。包测试位于 \tests 文件夹中。

要执行包测试，请导航到包的根目录： vendor\Mashytski\Trumail

添加您的 phpunit.xml。请确保在此处设置您的 Trumail 令牌。以下是一个示例

<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
  backupGlobals="false"
  backupStaticAttributes="false"
  colors="true"
  verbose="true"
  convertErrorsToExceptions="true"
  convertNoticesToExceptions="true"
  convertWarningsToExceptions="true"
  processIsolation="false"
  stopOnFailure="false">
  <testsuites>
    <testsuite name="MyPackage Test Suite">
      <directory>tests</directory>
    </testsuite>
  </testsuites>
  <filter>
    <whitelist>
      <directory suffix=".php">src/</directory>
    </whitelist>
  </filter>
  <php>
    <env name="APP_ENV" value="testing"/>
    <env name="TRUMAIL_TOKEN" value="PLACE_YOUR_TRUMAIL_TOKEN_HERE"/>
  </php>
</phpunit>

许可证

此包是开源软件，根据 MIT 许可证许可。

联系方式

对于有关包的问题、错误、建议和/或功能请求，请使用 Gitlab 问题系统并/或提交一个拉取请求。在提交问题时，请始终提供有关问题的详细说明，任何响应或反馈，可能相关的日志消息以及演示问题的源代码示例。如果不这样做，我可能无法帮助您解决问题。请在提交问题或拉取请求之前查看贡献指南。

对于任何其他问题，请随时使用以下凭证

Kelvin Macharia（开发者）

电子邮件：ngunyimacharia@gmail.com
电话：（+254）726 832329

mashytski / trumail

维护者

详细信息