README

Yii2 email sender

Отправка транзакционных и тригерных e-mail сообщений с использованием шаблонов созданных в личном кабинете сервиса https://kennwort.ru. Шаблоны используют механизм layout, что позволяет просто вносить изменения в ваши тригерные и транзакционные шаблоны писем.

Данный компонент использует пакет devrusspace/kennwort-email-sender, который взаимодействует с api сервиса. Документация по api размещена по адресу https://api.kennwort.ru/doc.

Установка

Предпочтительный способ установки этого расширения - через composer.

Выполните

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

или добавьте

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

в секцию require вашего файла composer.json и выполните php composer.phar install.

Использование

добавьте kennwort в секцию components вашего config.php

<?php
return [
    'components' => [
        'kennwort' => [
            'class' => 'Devrusspace\KennwortYii2\ApiClient',
            'token' => 'ваш_токен_созданный_в_личном_кабинете',
            'defaultSenderId' => 'идентификатор_email_из_вашего_списка_отправителей',
        ],
    ]
];
?>

Отправка письма на основе шаблона

Шаблон письма предварительно должен быть создан в личном кабинете. Имя и e-mail отправителя указываются при создании/редактировании шаблона.

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

Пример ответа:

print_r($result);

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

Идентификатор письма полученный в ответе вы можете использовать для получения расширенной информации по отправленному письму.

Отправка произвольного сообщения

Отправитель по умолчанию

Отправка письма от отправителя по умолчанию, сгенерированного на стороне вашего приложения :

<?php  
$mailTo = ['test@test.com' => 'Имя получателя'];
$subject = 'Заголовок письма';
$body = 'Html код содержимого письма';
$result = Yii::$app->kennwort->sendEmailDefaultSenderBody($mailTo, $subject, $body);
?>

Ответ идентичен методу Отправка письма на основе шаблона

С указанием отправителя

Отправка письма, сгенерированного на стороне вашего приложения :

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

Ответ идентичен методу Отправка письма на основе шаблона

Получение информации об отправленном сообщении

После отправки сообщения клиенту вы можете обратиться к этому методу, чтобы получить расширенную информацию. Например, время фактической отправки/прочтения или перехода по ссылке из письма.

<?php  
$result = Yii::$app->kennwort->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 = Yii::$app->kennwort->getTransactionsTemplates($page, $perPage);
?>

Пример ответа:

print_r($result);

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

)

Получение списка отправителей

Вы можете запросить список отправителей с e-mail которых будут уходить отпарвляемые вами письма. Отправители добавляются/редактируются через личный кабинет.

<?php  
$page = 1;
$perPage = 50;
$result = Yii::$app->kennwort->getSenders($page, $perPage);
?>

Пример ответа:

print_r($result);

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