Аккаунт
Выйти

Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки

Правила для входящих

Правила блокировки входящих писем сервера: письма от указанных адресов и доменов не отправляются на вебхук входящих. Те же правила настраиваются во вкладке «Правила блокировки» входящего канала.

Список правил #

get

/triggers/inboundrules

Возвращает правила блокировки входящих писем сервера.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Серверный API-ключ: входящие письма принадлежат серверу. Ключ есть в настройках сервера на вкладке «API-ключи».

Параметры строки запроса

count

Количество правил в ответе, от 1 до 500. По умолчанию 100.
offset

Сколько правил пропустить. По умолчанию 0.

Пример запроса с curl

curl "https://api.haskimail.ru/triggers/inboundrules?count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "TotalCount": 2,
  "InboundRules": [
    { "ID": 3, "Rule": "spam@example.com" },
    { "ID": 5, "Rule": "example.org" }
  ]
}

Создание правила #

post

/triggers/inboundrules

Письма от отправителя, подходящего под правило, получают статус Blocked и на вебхук не отправляются. Правило — email-адрес или домен целиком.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Серверный API-ключ: входящие письма принадлежат серверу. Ключ есть в настройках сервера на вкладке «API-ключи».
Content-Type обязательный

application/json

Тело запроса

Rule обязательный

Email-адрес (someone@example.com) или домен (example.com).

Пример запроса с curl

curl "https://api.haskimail.ru/triggers/inboundrules" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Server-Token: server token" \
  -d '{"Rule": "example.org"}'

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ID": 5,
  "Rule": "example.org"
}

Удаление правила #

delete

/triggers/inboundrules/{triggerid}

Удаляет правило по его ID.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Серверный API-ключ: входящие письма принадлежат серверу. Ключ есть в настройках сервера на вкладке «API-ключи».

Пример запроса с curl

curl "https://api.haskimail.ru/triggers/inboundrules/{triggerid}" \
  -X DELETE \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ErrorCode": 0,
  "Message": "Rule 5 removed."
}