README

Kennwort电子邮件发送器

使用在个人账户https://kennwort.ru中创建的模板发送交易性和触发性电子邮件。模板使用layout机制，允许您轻松更改触发性和交易性邮件模板。

API文档位于https://api.kennwort.ru/doc。

安装

安装此扩展的首选方法是通过composer。

执行

php composer.phar require devrusspace/kennwort-email-sender "^1.0"

或添加

"devrusspace/kennwort-email-sender": "^1.0"

到您的composer.json文件的require部分，然后执行php composer.phar install。

使用

创建应用程序令牌。将使用您的个人账户中创建的令牌调用组件。

<?php
$token = 'токен_вашего_приложения_сгенерированный_в_личном_кабинете';
$client = new \Devrusspace\Kennwort\ApiClient($token);

基于模板发送邮件

邮件模板必须先在个人账户中创建。创建或编辑模板时，指定姓名和发送者的电子邮件地址。

<?php  
$template = 'user/registration';
$mailTo = ['test@test.com' => 'Имя получателя'];
$params = ['var1' => 'значение переменной для подстановки в шаблон'];
$result = $client->sendEmail($template, $mailTo, $params);
$emailId = $result->email->id; // идентификатор отправленного сообщения

示例响应

print_r($result);

stdClass Object
(
    [result] => 1
    [email] => stdClass Object
        (
            [id] => 42bbd42d6dafddb160d61530f8ce9bb2
        )
)

在响应中获得的邮件标识符可用于获取有关已发送邮件的详细信息。

发送任意消息

发送由您的应用程序生成的邮件

<?php  
$senderId = 'идентификатор_email_из_вашего_списка_отправителей'
$mailTo = ['test@test.com' => 'Имя получателя'];
$subject = 'Заголовок письма';
$body = 'Html код содержимого письма';
$result = $client->sendEmailBody($senderId, $mailTo, $subject, $body);

响应与基于模板发送邮件方法相同

获取发送消息的详细信息

发送消息给客户后，您可以调用此方法以获取有关已发送消息的详细信息。例如，实际发送/阅读时间或点击邮件中链接的时间。

<?php  
$result = $client->getEmail($emailId);

示例响应

print_r($result);

stdClass Object
(
    [id] => 8993cc6ffbfd04173d846c0113a97abe
    [time_add] => 1671777031
    [time_sended] => 1671777031
    [time_opened] => 
    [time_clicked] => 
    [time_opened_last] => 
    [time_clicked_last] => 
    [opened] => 
    [cliked] => 
    [is_test] => 
)

获取模板列表

您可以请求通过个人账户添加的模板列表，例如在您的CRM系统中显示。

<?php  
$page = 1;
$perPage = 50;
$result = $client->getTransactionsTemplates($page, $perPage);

示例响应

print_r($result);

Array
(
    [0] => stdClass Object
        (
            [id] => daf1670c9aa1b629a294b4556ffa600d
            [key] => user/registration
            [name] => user / Приветсвенное письмо
            [mail_subject] => Приветсвуем в сервисе транзакционных рассылок
            [mail_pre_text] => {{userName}} отправлять через нас просто 🤠
        )

)

获取发送者列表

您可以请求包含发送电子邮件的电子邮件地址的发送者列表。发送者通过个人账户添加/编辑。

<?php  
$page = 1;
$perPage = 50;
$result = $client->getSenders($page, $perPage);

示例响应

print_r($result);

Array
(
    [0] => stdClass Object
        (
            [id] => 13d7c0f5a82f34ad9a76a163bc80a7f4
            [time_add] => 1669741763
            [email] => kennwort@devrus.space
            [name] => Сервис транзакционных рассылок
        )
)