Документация / Общая информация

Общая информация

fmailer отправляет письма из вашего приложения через SMTP или REST API. Работа строится вокруг двух сущностей: домен, с которого уходят письма, и токен — логин и пароль для доступа к отправке.

Домен

Домен добавляется в панели, после чего нужно подтвердить, что он ваш — для этого у регистратора прописываются NS-записи. Пока домен не подтверждён, отправка с него недоступна. Подробнее — в разделе «Настройка NS-записей».

Для отправки обычно выделяют поддомен, например mail.example.ru. Так репутация рассылок не смешивается с обычной перепиской сотрудников, а MX-записи основного домена остаются нетронутыми.

Токен

Токен создаётся для конкретного домена и состоит из логина и пароля. Одна и та же пара используется и для SMTP, и для REST API.

Логин и пароль можно получить на странице управления токенами домена.

Токенов может быть несколько — удобно завести отдельный для каждого сервиса или окружения. Любой токен можно отключить или удалить, не затрагивая остальные.

Способы отправки

  • SMTP — если в проекте уже настроена отправка почты, достаточно поменять хост, логин и пароль. Хост: smtp.fmailer.ru.
  • REST API — если нужны шаблоны, идемпотентность и разбор ответа в коде. База: https://api.fmailer.ru.

Первый запрос

Минимальный пример отправки письма через REST API:

send.shbash
curl -X POST "https://api.fmailer.ru/external/send_email_simple/" \
     -H "Content-Type: application/json" \
     -d '{
         "recipient": "client@example.ru",
         "sender": "Магазин <noreply@mail.example.ru>",
         "subject": "Подтверждение заказа №4417",
         "body": "Заказ принят. Доставка — завтра до 18:00.",
         "idempotency_key": "order-4417",
         "auth": {
             "username": "<логин токена>",
             "password": "<пароль токена>"
         }
     }'

Что дальше

  • Журнал писем в панели показывает путь каждого письма и ответ сервера получателя.
  • Шаблоны позволяют хранить вёрстку на стороне сервиса и передавать только параметры.
  • Вебхуки сообщают вашему приложению о доставке, отказах и жалобах.