API и прокси
записей в теме: 52
client<proxy>критичноДирективаАдрес отправки, который прокси обязан использовать; вместе с server это две обязательные строки блока.enable-source-ip-limits-on-sending-ip<domain>критичноДирективаВажно при отправке через прокси: локальный адрес и тот, что видит получатель, — разные.server<proxy>критичноДирективаКуда узел подключается вместо приёмника; вместе с client это две обязательные строки блока.smtp-proxy-source-hostGlobalкритичноДирективаВендорский способ отправлять через прокси — локальный адрес, прокси, адрес клиента и имя в приветствии одной строкой.http-enable-api-configGlobalДирективаОткрывает интерфейс, позволяющий заводить списки адресов и адреса отправки по HTTP; выключен по умолчанию.http-webhook-url<acct-file>Хаб задаёт самДирективаЭндпоинт, принимающий записи учёта по HTTP; путь в теге блока при этом остаётся и служит промежуточным хранилищем.include-tlv<proxy>ДирективаДобавляет в заголовок PROXY поле с доменом очереди; работает только при второй версии протокола.protocol-version<proxy>ДирективаВерсия заголовка HAProxy, 1 или 2; не задана — берётся у адреса отправки, затем у узла.proxy-include-tlvGlobalДирективаДобавляет в заголовок PROXY поле с доменом очереди; требует второй версии протокола.retry-attempts<proxy>ДирективаЧисло попыток соединения с прокси до перехода к следующему в списке; умолчание одна, потолок десять.use-inbound-proxy<smtp-listener>ДирективаТребует заголовок PROXY в начале соединения и берёт настоящий адрес клиента из него; по умолчанию выключено.use-proxyGlobalДирективаПеречень блоков прокси в порядке запасных; второй берётся, только когда первый не ответил.http-delivery-url<domain>ДирективаОбязателен для очереди вида http-delivery; абсолютный адрес без учётных данных и строки запроса.http-webhook-extra-headers<acct-file>Хаб задаёт самДирективаПуть к файлу, каждая строка которого — заголовок HTTP, добавляемый к запросу с пачкой записей.http-webhook-max-connections<acct-file>ДирективаЧисло потоков отправки записей учёта на эндпоинт; умолчание один, потолок пятьдесят.http-webhook-max-interval<acct-file>Хаб задаёт самДирективаИнтервал сбора записей в пачку перед отправкой; минимум одна минута, умолчание пять.inbound-proxy-timeout<smtp-listener>ДирективаПредел ожидания заголовка PROXY в начале соединения; умолчание пять секунд, ноль означает «ждать всегда».proxy-protocolGlobalДирективаВерсия заголовка HAProxy, 1 или 2; умолчание первая.use-inbound-proxy<transmissions-api-listener>ДирективаТребует заголовок PROXY в начале соединения и берёт настоящий адрес клиента из него; по умолчанию выключено.http-delivery-extra-headers<domain>ДирективаЕдинственное место, куда кладут авторизацию: в самом адресе учётные данные запрещены.http-webhook-ca-file<acct-file>ДирективаПуть к файлу PEM с сертификатами центров, по которым узел проверяет сертификат эндпоинта.http-webhook-certificate<acct-file>ДирективаФайл PEM с сертификатом, который узел предъявляет эндпоинту, если тот его запросит.http-webhook-connect-timeout<acct-file>ДирективаПредел ожидания при подключении к эндпоинту вебхука; умолчание пять секунд.http-webhook-io-timeout<acct-file>ДирективаПредел ожидания любой операции обмена с эндпоинтом после установления соединения; умолчание пять секунд.http-webhook-log-verbose<acct-file>ДирективаДобавляет в журнал MTA сообщения об отправке пачек, не только об ошибках; по умолчанию выключена.http-webhook-transfer-encoding<acct-file>ДирективаЕдинственное поддерживаемое значение gzip; по умолчанию содержимое уходит без сжатия.inbound-proxy-timeout<transmissions-api-listener>ДирективаПредел ожидания заголовка PROXY в начале соединения; умолчание пять секунд, ноль означает «ждать всегда».log-inbound-proxy<transmissions-api-listener>ДирективаПишет в журнал полученный заголовок PROXY; работает только при включённом приёме такого заголовка.add-x-msys-api-header<domain>ДирективаДописывает служебный заголовок, которым задаются настройки SparkPost, и переносит в него метку задания как имя кампании; уже стоящий заголовок не трогается.add-x-msys-api-header-metadata<domain>ДирективаПереносит содержимое названных заголовков в служебный заголовок службы; не работает без родительской строки, при уже стоящем заголовке и для заголовков, которые узел добавляет сам.customer-id<signals>ДирективаДо версии 5.5 требовалась при отслеживании силами MTA; начиная с 5.5 не нужна.sparkpost-ip-pool<domain>ДирективаНазывает пул адресов на стороне службы; сами адреса при этом не ваши, и репутация у них общая с другими её клиентами.sparkpost-sandbox<domain>ДирективаПередаёт SparkPost настройку песочницы: письмо уходит с тестового домена SparkPost без своего домена отправки, а таких писем на аккаунт по документации SparkPost не больше пяти.upload-url<signals>ДирективаЭндпоинт приёма событий; по умолчанию адрес службы вендора.Именованный прокси и три уровня его настроеккритичноМеханизмБлок несёт адрес прокси, внешний адрес отправки, версию протокола, тип поля и число попыток; первые две строки обязательны.Внешние адреса на одной машине, узлы внутрикритичноМеханизмУзлы стоят на внутренних адресах и выходят наружу через прокси, на котором собраны все внешние адреса отправки.Форматы ответа монитораМеханизмВеб-монитор отдаёт страницы человеку по адресу с /ui, а программе — XML или JSON по тому же адресу без суффикса.Как API сообщает об ошибкеМеханизмПодача по HTTP сообщает об ошибках кодами ответа, а API настройки на всё, кроме отказа в доступе, отвечает 200 и пишет исход в поле status.Форматы вывода командМеханизмКоманды узла умеют печатать не только текст, но и структуру.Как обвязка сообщает об ошибкеМеханизмОбвязка C++ сообщает об ошибке исключением, после которого объект выбрасывают; обвязка C — возвратом признака и отдельным запросом последней ошибки.Жизнь объекта в обвязке CМеханизмВ обвязке C каждый объект выделяют, инициализируют и освобождают явно — там, где в C++ это делают конструктор и деструктор.<proxy>Блок конфигурацииИменованный блок с адресом прокси и внешним адресом отправки; обе строки обязательны, блоков может быть несколько.<transmissions-api-listener>Блок конфигурацииАдрес, порт и шифрование для подачи писем по HTTP.<transmissions-api>Блок конфигурацииКлючи доступа, предел размера запроса и журналирование для подачи почты по HTTPS; объявляется один раз в корне файла.show registrationКомандаПечатает, зарегистрирован ли узел в консоли вендора.deregisterКомандаПрекращает отношение с консолью вендора.registerКомандаУстанавливает отношение между узлом и управляющей консолью вендора.Выполнить команду по сетикритичноТочка APIВыполняет команду консоли узла, переданную запросом, и отдаёт результат структурой или текстом.Отдать файл узлакритичноТочка APIОтдаёт журнал или файл учёта по имени из перечня /logs.Состояние узла целиком одним документомкритичноТочка APIОтдаёт страницу состояния структурой в XML или JSON: продукт, лицензия, машина, трафик, соединения, резолвер, очереди, спул и признак работы — одним ответом.Перечень журналов и файлов учётаТочка APIПеречисляет файлы журнала и учёта, которые монитор может отдать; само содержимое — через /getFile.Корень веб-монитораТочка APIОтдаёт начальную страницу монитора структурой: сведения об установке и верхние домены очереди.