Сервер-песочница

Что такое сервер-песочница #

Сервер-песочница устроен так же, как живой сервер: у него есть каналы отправки, API-токены и SMTP-реквизиты, шаблоны, вебхуки и статистика. Отличие одно — письма с него не доставляются получателям.

Песочницу удобно использовать в тестовом или staging-окружении: не нужно подменять адреса получателей в коде, и нет риска случайно отправить тестовое письмо реальному клиенту. Когда интеграция готова, достаточно заменить токен или SMTP-реквизиты на реквизиты живого сервера.

Песочницей можно пользоваться сразу после регистрации, ещё до окончания модерации аккаунта: письма с неё принимаются на любые адреса, ведь до получателей они всё равно не доходят.

Что происходит с письмом #

Письмо проходит те же проверки, что и на живом сервере: настроен ли домен, подтверждён ли отправитель, нет ли получателя в списке блокировок, допустимы ли вложения. Если письмо проверку не прошло, вы увидите ту же ошибку, что получили бы при настоящей отправке.

Если проверки пройдены, письмо считается отправленным:

оно появляется в активности и статистике сервера;
срабатывает вебхук об отправке (событие sent);
API возвращает обычный ответ с MessageID.

Чего не будет

Письмо не уходит получателю, поэтому не будет событий доставки, открытий, кликов и возвратов. Чтобы проверить обработку возвратов, используйте тестовые адреса — они работают и на песочнице.
Не расходуются ни лимит писем, ни кредиты. Письма с песочницы принимаются даже при нулевом балансе.

Создание сервера-песочницы #

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

При создании нового сервера выберите тип «Песочница». В списке серверов, в настройках и в заголовке страниц сервера песочница отмечена жёлтой меткой «Песочница».

Тип сервера задаётся один раз и не меняется. Чтобы перевести интеграцию в бой, создайте живой сервер и переключите приложение на его токен или SMTP-реквизиты.

Через Servers API

Передайте "DeliveryType": "Sandbox" при создании сервера. Без этого поля создаётся живой сервер (Live). Поле DeliveryType возвращается во всех ответах Servers API, но изменить его после создания нельзя.

curl "https://api.haskimail.ru/servers" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d '{
  "Name": "Staging",
  "Color": "Yellow",
  "DeliveryType": "Sandbox"
}'

Отправка через песочницу #

Через API

Используйте токен сервера-песочницы в заголовке X-Haskimail-Server-Token — сам запрос ничем не отличается от обычной отправки. Поле MessageStream можно не указывать: письмо уйдёт в транзакционный канал песочницы по умолчанию. Если канал указан, он должен принадлежать этому же серверу, иначе API вернёт ошибку 1226.

Через SMTP

Используйте SMTP-реквизиты канала песочницы — они находятся в настройках канала. Как и на живом сервере, SMTP нужно предварительно включить в настройках сервера. Подробнее — в разделе Отправка писем через SMTP.