README

使用PHP编写的API客户端，提供对rapidmail API当前版本的访问。

使用Composer安装

首选的安装方法是使用Composer依赖管理器。

composer require rapidmail/rapidmail-apiv3-client-php

入门指南

创建一个新的API客户端实例并提供您的APIv3凭证

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

use Rapidmail\ApiClient\Client;

$client = new Client('api_username_hash', 'api_password_hash');

之后，您可以访问客户端封装的各种服务

$mailingService = $client->mailings();

// Iterate all mailings 

foreach($mailingService->query() as $mailing) {
    var_dump($mailing);
}

示例

检索邮件

获取应用了一些过滤器的邮件列表

// Filter for sent mailings newer than a given date 

var_dump(
    $mailingService->query([
        'created_since' => '2019-09-01 10:22:00',
        'status' => 'sent'
    ])
);

检索收件人列表

$listService = $client->recipientlists();

foreach ($listService->query() as $list) {
    var_dump($list);
}

检索收件人

$recipientsService = $client->recipients();

$collection = $recipientsService->query(
    [
        'recipientlist_id' => 123456789 // Recipientlist ID MUST be provided
    ]
);

foreach ($collection as $recipient) {
    var_dump($recipient);
}

创建一个新的收件人

$recipientsService = $client->recipients();

var_dump(
    $recipientsService->create(
        // Dataset: Represents the recipient dataset you're creating
        [
            'recipientlist_id' => 123456789, // Required
            'email' => 'john@example.net', // Required
            'firstname' => 'John',
            'lastname' => 'Doe',
            'gender' => 'male'
        ],
        // Flags: Configures system behavior, like sending activationmails
        [
            'send_activationmail' => 'yes'
        ]
    )
);

错误处理

始终要记住正确处理错误并捕获可能发生的异常

use \Rapidmail\ApiClient\Exception\ApiClientException;

try {
    $mailingService->query(['status' => 'unknown']);
} catch (ApiClientException $e) {
    // Catch API client exceptions
    echo "Exception raised: " . $e->getMessage();
}

文档

有关使用API客户端的更多信息，请参阅以下子部分

已知问题

在PHP版本7.4.5和8.1.2上使用时，当生成201 HTTP响应码（用于成功创建数据集时）时，将生成异常。如果您遇到这些问题版本，请尝试升级到更晚的PHP版本。
客户端版本<1.1.6与guzzlehttp/guzzle 7.8+不兼容。请升级到1.1.6或更高版本，或将guzzlehttp/guzzle版本降级到7.7。

有关可用端点和其参数的完整列表，请参阅API文档。

许可证

rapidmail APIv3客户端根据BSD 2-clause许可证的条款进行许可。

支持

联系方式： www.rapidmail.de - support@rapidmail.de - +49 761 - 216 08 720

rapidmail / rapidmail-apiv3-client-php

维护者

详细信息