Вебхук для жалоб на спам

Что такое жалоба на спам? #

Жалоба на спам регистрируется, когда пользователь в своем почтовом ящике нажимает кнопку «Это спам» в таких почтовых клиентах, как Yahoo, Hotmail, AOL и других. В идеале у вас не должно быть жалоб на спам, но они все же случаются. Как только жалоба на спам зарегистрирована, Haskimail деактивирует этот адрес и не позволит вам активировать его повторно.

В индустрии email-рассылок жалобы на спам — это четкий показатель злоупотреблений и некачественных практик отправки. Нам важно серьезно относиться к этим жалобам, чтобы обеспечивать наилучшую доставляемость для всех наших клиентов. Если вы считаете, что жалоба на спам была ошибочной и адрес следует повторно активировать, пожалуйста, свяжитесь напрямую со службой поддержки Haskimail.

Примечание: Дата и время в поле BouncedAt передаются в формате ISO 8601.

Настройка URL вебхука для жалоб на спам #

Через веб-интерфейс Haskimail

Войдите в аккаунт Haskimail, выберите нужный Сервер и Канал, а затем перейдите на вкладку «Вебхуки». Нажмите «Добавить вебхук», введите URL в поле «URL вебхука» и установите флажок напротив события «Жалоба на спам» (COMPLAINED).

Через API

Вы можете настроить событие COMPLAINED с помощью API как при создании нового вебхука, так и при редактировании уже существующего.

Данные вебхука для жалоб на спам #

Пример полного JSON-документа, который будет отправлен POST-запросом на ваш URL вебхука, показан справа. Ниже приведено краткое описание некоторых ключевых полей:

Email— email-адрес получателя.
Tag — тег доставки, который был использован при отправке сообщения.
BouncedAt — временная метка, когда произошла жалоба.
Subject — тема отправленного письма.
Metadata — пользовательские метаданные, которые были добавлены в письмо.

Пример JSON данных вебхука

{
  "RecordType": "SpamComplaint",
  "MessageStream": "outbound",
  "ID": 42,
  "Type": "SpamComplaint",
  "TypeCode": 512,
  "Name": "Spam complaint",
  "Tag": "Test",
  "MessageID": "00000000-0000-0000-0000-000000000000",
  "Metadata" : {
    "a_key" : "a_value",
    "b_key": "b_value"
   },
  "ServerID": 1234,
  "Description": "",
  "Details": "Test spam complaint details",
  "Email": "ivan@example.com",
  "From": "masha@example.com",
  "BouncedAt": "2019-11-05T16:33:54.9070259Z",
  "DumpAvailable": true,
  "Inactive": true,
  "CanActivate": false,
  "Subject": "Test subject",
  "Content": "<Abuse report dump>"
}

Тестирование вебхука для жалоба на спам с помощью curl #

Если вы ведете разработку на локальной машине или у вас нет публичного URL для вашего API, вы можете использовать пример POST-запроса, показанный справа. Замените <your-url> на API-маршрут, который вы хотите использовать в качестве URL вашего вебхука. Этот curl-запрос позволит вам убедиться, что ваш URL может принимать запросы в том же JSON-формате, который будут использовать серверы Haskimail.

Пример вызова curl

curl <your-url> \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "ID": 42,
  "Type": "SpamComplaint",
  "TypeCode": 512,
  "Name": "Spam complaint",
  "Tag": "Test",
  "MessageID": "00000000-0000-0000-0000-000000000000",
  "ServerID": 1234,
  "Description": "",
  "Details": "Test spam complaint details",
  "Email": "ivan@example.com",
  "From": "masha@example.com",
  "BouncedAt": "2018-02-20T12:54:23.3396434-05:00",
  "DumpAvailable": true,
  "Inactive": true,
  "CanActivate": false,
  "Subject": "Test subject"
}'

Как можно использовать данные о жалобах на спам #

Существует множество способов использования данных, которые предоставляет вебхук для жалоб на спам:

Мгновенно узнавать, что конкретное письмо было явно помечено как спам, и предпринимать дальнейшие действия на основе этого события.
Использовать данные для создания статистики, специфичной для вашего приложения.
Предоставлять пользователям интерфейс, позволяющий им отслеживать, что произошло с их email-уведомлениями.