sender.type_settings

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

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

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

Рассылки

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

$params['sender_id'] int ID отправителя.
$params['sender'] array Массив основных свойств отправителя со следующими ключами:
$params['sender']['id'] int ID отправителя.
$params['sender']['name'] string Название.
$params['sender']['email'] string Email-адрес.
$params['sender']['domain'] string Домен email-адреса.
$params['sender']['one_string_key'] string Сгенерированное значение TXT-записи подписи DKIM.
$params['sender_params'] array Массив ранее сохранённых дополнительных параметров отправителя со следующими ключами:
$params['sender_params']['type'] string Тип отправителя из списка: 'default' (по умолчанию), 'mail' (функция mail()), 'smtp' (SMTP-сервер), 'sendmail' (команда sendmail). Или другой тип отправителя, если он добавлен с помощью плагина.
$params['sender_params']['reply_to'] string Адрес Reply-To.
$params['sender_params']['dkim'] bool Флаг, означающий использование подписи DKIM.
$params['sender_params']['dkim_pub_key'] string Публичный ключ для использования подписи DKIM.
$params['sender_params']['dkim_pvt_key'] string Приватный ключ для использования подписи DKIM.
$params['sender_params']['dkim_selector'] string Начальная часть значения «Хост» TXT-записи подписи DKIM.
$params['sender_params']['encryption'] string Значение настройки «Шифрование» для отправителя типа «SMTP»: 'ssl' или 'tls'.
$params['sender_params']['options'] string Значение настройки «Параметры» для отправителя типа «PHP-функция mail()».
$params['sender_params']['server'] string Значение настройки «Сервер» для отправителя типа «SMTP».
$params['sender_params']['port'] int Значение настройки «Порт» для отправителя типа «SMTP».
$params['sender_params']['login'] string Значение настройки «Логин» для отправителя типа «SMTP».
$params['sender_params']['password'] string Значение настройки «Пароль» для отправителя типа «SMTP».
$params['sender_params']['openssl'] bool Флаг, означающий доступность PHP-расширения openssl.
$params['sender_params']['php_version_ok'] bool Флаг, означающий соответствие версии PHP возможности использования подписи DKIM.
$params['sender_params']['php_version'] string Номер версии PHP.
$params['types'] array Список доступных типов транспорта отправки сообщений, который можно изменять плагином. Ключи массива — значения из списка: 'default' (по умолчанию), 'mail' (функция mail()), 'smtp' (SMTP-сервер), 'sendmail' (команда sendmail), или другие, добавленные плагинами. Обозначения типов, добавленные плагином, должны начинаться с идентификатора этого плагина. Значения элементов списка — массивы со следующими ключами:
$params['types'][type]['name'] string Название транспорта.
$params['types'][type]['description'] string Описание транспорта.

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

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

$return

Массив новых типов транспорта, предоставленных плагином. Каждый элемент — подмассив со следующими ключами:
[]['name'] string Название.
[]['description'] string Описание.

Рассылки

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

PHP

public function senderTypeSettings(&$params)
{
    // Either modify the incoming types array
    $params['types'][$this->id . 'transport'] = [
        'name' => _wp('My plugin’s transport'),
        'description' => _wp('A really cool one!'),
    ];

    // Or return new transport options
    return [
        $this->id . 'transport' => [
            'name' => _wp('My plugin’s transport'),
            'description' => _wp('A really cool one!'),
        ]
    ];
}