campaign.validate_test
Срабатывает при проверке данных перед тестовое отправкой рассылки. Позволяет показать собственное сообщение об ошибке.
Доступно начиная с версии 1.0.4.
Рассылки
Входящие параметры (передаются по ссылке)
$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' (функция
$params['params']['speed_limit'] int Скорость рассылки в виде количества сообщений, отправляемых в течение 1 часа.
$params['addresses'] array Массив получателей тестового сообщения. Ключи массива — email-адреса, значения — имена получателей.
$params['errors'] 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['addresses'] array Массив получателей тестового сообщения. Ключи массива — email-адреса, значения — имена получателей.
$params['errors'] array Сообщения об ошибках в виде массива. Плагин может добавить своё сообщение в этот массив.
… код плагина …
Результат работы плагина
Рассылки
Пример кода плагина
PHP
public function campaignValidateTest(&$params)
{
$error_message = mailerMyPluginHelper::validateCampaignTest($params);
if (strlen($error_message)) {
$params['errors'][] = $error_message;
}
}
