README

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

要求

此软件包需要至少 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/。

emailcenter / mxm-api-php

维护者

详细信息

README

要求

安装

使用示例

日志记录

辅助工具

许可证