README

MailSlurp-PHP

MailSlurp 是一个端到端电子邮件测试服务。它有一个用于管理账户的 web-app，以及一个用于发送和接收随机生成电子邮件地址的电子邮件的 REST API。

为什么使用它？

MailSlurp 是为了测试应用中电子邮件服务的集成而构建的。如果你的应用程序依赖于发送或接收电子邮件，那么 MailSlurp 将让你测试该功能。这可能比你想象的更常见：如果你的应用程序有一个需要电子邮件验证的注册过程，你目前是如何测试的？

入门指南

每个 API 请求都需要一个有效的 API Key，该 Key 作为查询参数附加。要获取 API Key，请访问您的账户仪表板。

一般流程如下：

在测试期间创建一个新的邮箱。电子邮件地址将在 apiReponse 中返回。
向该地址发送电子邮件或在您的测试中触发一个这样做的事件。
获取您新邮箱的电子邮件，并检查其内容是否符合您期望的内容，或者使用该内容执行另一个操作。

SDK

在 npm 上有一个官方的 JavaScript SDK。
此 PHP 版本是从 swagger JSON 定义生成的，使用 swagger-codegen 并适配用于 PHP 7.0+（请参阅提交以获取更改的完整列表）。

法律

Mailslurp API 代码归 PettmanUG 所有，并使用专有软件许可。SDK 是免费使用的，并具有 ISC 许可。

错误、功能、支持

要报告错误或请求功能，请参阅联系页面。如需帮助，请参阅支持。

要求

PHP 7.0 及以上版本

安装与使用

Composer

通过Composer安装绑定，运行以下命令

composer require rvalitov/mailslurp-php

或者手动将以下内容添加到composer.json

{
  "require": {
    "rvalitov/mailslurp-php": "^0.0.1"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

    require_once('/path/to/MailSlurp-PHP/vendor/autoload.php');

测试

注意。测试尚未实现！

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装过程操作，然后运行以下命令

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

$apiInstance = new Swagger\Client\Api\AccountControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$jwt_token = "jwt_token_example"; // string | Cognito ID obtained during login
$stripe_token = "stripe_token_example"; // string | Stripe user payment confirmation token

try {
    $result = $apiInstance->createSubscriptionUsingPOST($jwt_token, $stripe_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->createSubscriptionUsingPOST: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI均相对于https://api.mailslurp.com

类	方法	HTTP请求	描述
AccountControllerApi	createSubscriptionUsingPOST	POST /subscription	将用户升级为付费
AccountControllerApi	getAccountsUsingGET	GET /accounts	列出可用的账户类型
InboxControllerApi	createRandomInboxUsingPOST	POST /inboxes	创建一个收件箱
InboxControllerApi	deleteInboxUsingDELETE	DELETE /inboxes/{uuid}	删除一个收件箱
InboxControllerApi	getEmailsForInboxUsingGET	GET /inboxes/{uuid}	获取给定收件箱的邮件
InboxControllerApi	getListOfInboxesUsingGET	GET /inboxes	列出您的收件箱
InboxControllerApi	sendEmailFromUserUsingPOST	POST /inboxes/{uuid}	发送一封邮件
UserControllerApi	getUserUsingGET	GET /user	获取一个用户

模型文档

授权文档

所有端点均不需要授权。

从Swagger生成

如果您想从Swagger生成原始代码，请使用以下命令

wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.1/swagger-codegen-cli-2.3.1.jar -O swagger-codegen-cli.jar
java -jar .\swagger-codegen-cli.jar generate -i https://api.mailslurp.com/v2/api-docs -l php -o ./out

rvalitov / mailslurp-php

维护者

详细信息