README

Zenmail 是由 Templateria 开发的电子邮件营销工具。这个 PHP 库是其 API 的客户端，允许自动化 Web 控制面板中的任何功能。

Zenmail 的 Web 控制面板本身也使用了其 API - 这是确保 API 完整且易于使用的一种方式。

安装

composer require templateria/zenmail-php

认证

通过发送电子邮件至 suporte@zenmail.com.br 向支持团队请求访问令牌。

简介

所有对 API 的请求都通过 Zenmail\Client 实例进行。

$zenmail = new Zenmail\Client([
    'token'      => 'seu token aqui'
    'account_id' => 9999
])

通过流畅的接口，您可以访问 API 中所有可用的资源。

$contact = $zenmail->contacts->get('pedro@templateria.com'); // obtém um contato pelo email
$contact = $zenmail->contacts->get(58978456);                // ou então diretamente pelo ID

路线图

这个库目前处于开发初期阶段。以下操作可用：

联系人 [x] 创建联系人 [x] 列出联系人 [x] 搜索联系人 [x] 删除联系人 [x] 更新联系人

列表

[x] 创建列表

[x] 将联系人添加到列表

[x] 搜索列表

[x] 返回列表

[x] 删除列表

[x] 更新/编辑列表

联系人管理

创建联系人

$zenmail->contacts->create([
    'email'   => 'pedro@templateria.com',
    'details' => ['nome' => 'Pedro']
]);

获取联系人

$contact = $zenmail->contacts->get('pedro@templateria.com'); // obtém um contato pelo email
$contact = $zenmail->contacts->get(58978456);                // ou então diretamente pelo ID

列出联系人（通过电子邮件搜索）

// retorna todos os contatos do domínio templateria.com
$zenmail->contacts->find(['email' => '@templateria.com']);

更新联系人

$zenmail->contacts->update($contact->id, [
    'details' => [
        'nome'      => 'Pedro',
        'sobrenome' => 'Padron',
        'empresa'   => 'Templateria'
    ]
]);

删除联系人

$zenmail->contacts->delete($contact->id);

列表

创建列表

$zenmail->contactLists->create(['name' => 'Assinantes da Newsletter']);

将联系人添加到列表

如果联系人尚未存在于账户中，它将自动创建。如果联系人已存在于其他列表中，它将仅添加到另一个列表中。

$zenmail->contactLists->append($listId, ['email' => 'pedro@templateria.com']);

通过名称搜索列表

$lists = $zenmail->contactLists->find(['name' => 'Assinantes da Newsletter']);

返回列表

$lists = $zenmail->contacts->get(['name' => 'Assinantes da Newsletter']);

更新/编辑列表

$listId = 9999;
$zenmail->contactLists->update($listId, ['name' => 'Assinantes da Newsletter pelo Site']);

删除列表

$listId = 9999;
$lists  = $zenmail->contactLists->delete($listId);

活动

获取活动

$zenmail->campaigns->get(12345);

列出活动

foreach ($zenmail->campaigns->all() as $campaign) {
    echo 'Campanha #' . $campaign->id . ': ' . $campaign->subject;
}

$page = 1;

do {
    $campaigns = $zenmail->campaigns->find(['page' => $page]);
    $lastPage  = $campaigns->getPaginationData()->last_page;
    foreach ($campaigns as $campaign) {
        echo 'Campanha #' . $campaign->id . ': ' . $campaign->subject . "\n";
    }
    $page++;
} while ($page <= $lastPage);

创建活动

$campaign = $zenmail->campaigns->create([
    'recipients' => 'lists',
    'list_ids'   => [329104],
    'subject'    => 'Novidades do Zenmail',
    'from_name'  => 'Zenmail',
    'from_email' => 'suporte@zenmail.com.br',
    'html'       => $html,
]);

发送活动

$zenmail->campaigns->send($campaign->id);

编辑活动

$campaign = $zenmail->campaigns->update([
    'recipients' => 'all'
]);

删除活动

$zenmail->campaigns->delete($campaign->id);

支持

访问我们的文档了解更多关于 Zenmail 的信息，如果有任何疑问，请发送电子邮件至 suporte@zenmail.com.br。

安全

有关安全问题（如发现的漏洞或其他事宜），请发送电子邮件至 suporte@zenmail.com.br。

变更日志

关于此库每个版本的详细信息可在 CHANGELOG.md 文件中找到。

templateria / zenmail-php

维护者

详细信息