campaign.settings

Приложения » Рассылки »

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

Доступно начиная с версии 2.1.2.

Рассылки

Входящие параметры (передаются по ссылке)

$params['campaign'] array Массив свойств рассылки со следующими ключами:
$params['campaign']['id'] int ID сообщения.
$params['campaign']['body'] string Текст сообщения.
$params['campaign']['count_products'] int Количество блоков для отображения товаров Shop-Script в шаблоне, на основе которого было составлено сообщение.
$params['campaign']['create_contact_id'] int ID пользователя, который создал черновик сообщения.
$params['campaign']['create_datetime'] datetime Дата и время создания черновика сообщения в формате «гггг-мм-дд чч:мм:сс».
$params['campaign']['from_email'] string Email-адрес отправителя.
$params['campaign']['from_name'] string Имя отправителя.
$params['campaign']['rebody'] string Исходный код сообщения в формате, используемом визуальным редактором.
$params['campaign']['reply_to'] string Адрес Reply-To.
$params['campaign']['return_path'] string Адрес Return-Path.
$params['campaign']['sender_id'] int ID отправителя, выбранного в настройках сообщения.
$params['campaign']['subject'] string Тема сообщения.
$params['params'] array Массив параметров рассылки со следующими ключами:
$params['params']['google_analytics'] bool Флаг, означающий, включены ли UTM-метки.
$params['params']['google_analytics_utm_campaign'] string Значение UTM-метки utm_campaign.
$params['params']['google_analytics_utm_medium'] string Значение UTM-метки utm_medium.
$params['params']['google_analytics_utm_source'] string Значение UTM-метки utm_source.
$params['params']['recipients_count'] int Количество получателей.
$params['params']['sender_port'] int Номер порта для подключения к серверу отправителя.
$params['params']['sender_reply_to'] string Адрес Reply-To.
$params['params']['sender_server'] string Адрес почтового сервера отправителя.
$params['params']['sender_type'] string Обозначение типа отправителя из списка: 'default' (по умолчанию), 'mail' (функция mail()), 'smtp' (SMTP-сервер), 'sendmail' (команда sendmail). Или другой тип отправителя, если он добавлен с помощью плагина.
$params['params']['speed_limit'] int Скорость рассылки в виде количества сообщений, отправляемых в течение 1 часа.
$params['return_paths'] array Список настроенных ящиков Return-Path. Каждый элемент списка — массив со следующими ключами:
$params['return_paths'][]['id'] int ID ящика.
$params['return_paths'][]['email'] string Адрес ящика.
$params['return_paths'][]['server'] string Имя сервера.
$params['return_paths'][]['port'] int Номер порта.
$params['return_paths'][]['login'] string Имя пользователя.
$params['return_paths'][]['password'] string Пароль.
$params['return_paths'][]['ssl'] bool Флаг, требующий использования SSL-сертификата для подключения.
$params['return_paths'][]['last_error'] string Последнее зарегистрированное сообщение об ошибке.
$params['senders'] array Список отправителей. Каждый элемент списка — массив со следующими ключами:
$params['senders'][]['id'] int ID отправителя.
$params['senders'][]['name'] string Название отправителя.
$params['senders'][]['email'] string Email-адрес отправителя.
$params['senders'][]['no_return_path'] bool Флаг, означающий отсутствие настроенного ящика Return-Path.
$params['senders'][]['type'] string Тип отправителя.

… код плагина …

Результат работы плагина

{$campaign.settings.top}

Дополнительный HTML-код для отображения в верхней части формы настроек рассылки.

{$campaign.settings.bottom}

Дополнительный HTML-код для отображения в нижней части формы настроек рассылки.

Рассылки

Пример кода плагина

PHP

public function campaignSettings(&$params)
{
    // Set a custom sender ID for the campaign.
    $params['campaign']['sender_id'] = 42;

    return [
        'top' => '<!-- custom content at the top -->',
        'bottom' => '<!-- custom content at the bottom -->',
    ];
}