mailinabox/mailinabox-api

Mail-in-a-Box API 的 PHP 客户端 SDK。

维护者

详细信息

github.com/badsyntax/mailinabox-api

主页

源代码

问题

安装: 5

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 1

开放问题: 2

0.51.1 2020-12-20 12:41 UTC

Requires

Requires (Dev)

MIT b3f5322576082c2b5b963015e19d89be632b2996

phprestapisdkmailinaboxmail-in-a-box

This package is auto-updated.

Last update: 2024-09-29 05:55:50 UTC

README

Build & Publish

Mail-in-a-Box API 的 PHP 客户端 SDK。

  • API 版本：0.51.0
  • 包版本：0.51.1

https://packagist.org.cn/packages/mailinabox/mailinabox-api

注意： 此包是由 Mail-In-A-Box OpenAPI 规范自动生成的。查看更多

需求

PHP 5.5 及以上版本

安装与使用

Composer

要通过 Composer 安装绑定，请在 composer.json 中添加以下内容：

{
  "require": {
    "mailinabox/mailinabox-api": "0.51.1"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/mailinabox-api-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门指南

请遵循安装过程，然后运行以下命令：

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



// Configure HTTP basic authorization: basicAuth
$config = MailInABoxAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MailInABoxAPI\Client\Api\DNSApi(
    // 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(),
    $config
);
$qname = 'qname_example'; // string | DNS query name.
$body = 1.2.3.4; // string | 

try {
    $result = $apiInstance->addDnsCustomARecord($qname, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DNSApi->addDnsCustomARecord: ', $e->getMessage(), PHP_EOL;
}

?>

API 端点文档

所有 URI 都相对于 https://box.example.com/admin

模型文档

授权文档

basicAuth

  • 类型：HTTP 基本认证

许可证

MIT 许可证

版权所有 (c) 2020 Richard Willis