maxemail/api-php

Maxemail API 客户端

维护者

详细信息

github.com/maxemail/api-php

源代码

问题

安装量: 9,488

依赖者: 0

建议者: 0

安全性: 0

星标: 3

关注者: 6

分支: 1

开放问题: 0

5.1.1 2021-09-10 13:50 UTC

Requires

Requires (Dev)

Suggests

LGPL-3.0 b9231f564dbd2617be83fc693e6b540ee2a58703

This package is auto-updated.

Last update: 2024-09-19 16:30:08 UTC

README

Code Checks Codecov Latest Stable Version Total Downloads Licence

PHP 中用于简化访问 Maxemail API 的自包含客户端

要求

PHP

此软件包需要至少 PHP 7.1。如需与较旧版本的 PHP 兼容，请查看之前的版本。

Composer 在安装/更新时将验证任何其他环境要求。

在创建此软件包的新主要版本时，我们可能会停止支持 PHP 项目不再 积极支持 的 PHP 版本。

安装

通过使用 Composer 可以轻松地将此软件包包含到您的应用程序中。

$ composer require maxemail/api-php

使用示例

// Instantiate Client:
$config = [
    'username' => 'api@user.com',
    'password' => 'apipass'
];
$api = new \Maxemail\Api\Client($config);

// General:
$result = $api->serviceName->method($arg1, $arg2);
var_dump($result);

日志记录

如果您想获得更有用的开发时间调试信息，请向 API 抛出一个 PSR 兼容的记录器

$logger = new Logger(); // Must implement \Psr\Log\LoggerInterface
$api->setLogger($logger);

有关快速开始日志记录（以及高级多目标日志记录！）的说明，请参阅 Phlib/Logger

辅助工具

客户端还包括一个 辅助 类，用于处理比简单请求-响应模型更复杂的常见场景。

通过客户端的 getHelper() 方法访问辅助工具

$api->getHelper()->downloadFile(...);

请参阅辅助方法中关于必需和可选参数的联机文档。

许可证

此软件包是自由软件：您可以在自由软件基金会发布的 GNU 较小通用公共许可证的条款下重新分配它和/或修改它，许可证版本为 3 或（根据您的选择）任何更高版本。

本程序的分发希望对您有用，但没有任何保证；甚至没有关于适销性或特定用途适用性的暗示保证。有关详细信息，请参阅 GNU 较小通用公共许可证。

您应该已收到 GNU 较小通用公共许可证的副本。如果没有，请参阅 https://gnu.ac.cn/licenses/。