alfredo-ramos/mailrelay-api-client

0.1.1 2022-06-15 20:44 UTC

This package is auto-updated.

Last update: 2024-08-30 08:25:20 UTC


README

关于

A Mailrelay API 客户端。

Build Status Latest Stable Version Code Quality License

⚠️ 尽管所有 API 端点都已实现,但仍在开发中,因此可能存在一些错误。

需求

  • PHP 7.2.5 或更高版本

安装

打开您的 composer.json 文件,并在 require 对象中添加包

"alfredo-ramos/mailrelay-api-client": "^0.1.0"

然后在您的终端中运行 composer update

使用方法

构造函数接收一个 array,包含连接到您的 Mailrelay 帐户所需的 API 数据。

require __DIR__ . '/vendor/autoload.php';

$mailrelay = new AlfredoRamos\Mailrelay\Client([
	'api_account' => 'mailrelay_account',
	'api_token' => 'mailrelay_api_token'
]);

您可以使用 AlfredoRamos\Mailrelay\Client::api() 方法访问每个端点。

// Create or update a subscriber
$mailrelay->api('subscribers')->sync([
	'status' => 'active',
	'email' => 'user@example.org',
	'group_ids' => [1]
]);

// Get account package info
$mailrelay->api('package')->info();

有关 Mailrelay API 端点的更详细信息,请参阅 官方 API 文档