Обзор

Интеграции

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

Справочник API

Вебхуки

Управление подписями отправителей

Зачем использовать API подписей отправителей? #

Подпись отправителя — это email-адрес, который будет отображаться в поле «От кого». Haskimail позволяет отправлять письма только с предварительно подтвержденных email-адресов. Обычно достаточно создать одну или две подписи отправителя на сайте Haskimail, и их хватит на все время использования аккаунта. Однако мы в Haskimail понимаем, что это подходит не всем нашим пользователям. Например, если вы хотите отправлять письма с большого количества адресов или динамически создавать подписи отправителей, участие человека в процессе становится непрактичным. Именно поэтому мы предоставляем RESTful API, с помощью которого наши клиенты могут программно управлять подписями отправителей через эндпоинт /senders. Для получения полной информации об этом эндпоинте, пожалуйста, обратитесь к справочнику по API подписей отправителей.

Когда не следует использовать API подписей отправителей #

Мы рекомендуем подтверждать домен, так как это самый быстрый способ обеспечить доставляемость писем. Настройка аутентификации DKIM и Return-Path не является абсолютно обязательной при создании подписи отправителя, но мы настоятельно рекомендуем ее внедрить для обеспечения доставляемости и безопасности. 

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

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

Аутентификация

Подписи отправителей принадлежат аккаунту. Это отличается от того, к чему вы могли привыкнуть при отправке писем, которые в Haskimail принадлежат отдельному серверу. Для управления подписями отправителей вам понадобится токен API аккаунта. Его может получить только владелец аккаунта на вкладке «Токены API» в личном кабинете Haskimail. Этот токен используется как значение HTTP-заголовка X-Haskimail-Account-Token. Этот HTTP-заголовок должен использоваться для аутентификации всех API-запросов к эндпоинту /senders. Если возникнет проблема с аутентификацией, вы получите HTTP-ответ со статус-кодом 401 (Unauthorized).

Обязательные поля

Для создания подписи отправителя требуются всего две части информации. 1). FromEmail — это email-адрес, который будет отображаться в поле «От кого» в отправляемых вами письмах. Это должен быть реально существующий почтовый ящик. Haskimail отправит письмо-подтверждение, которое необходимо подтвердить, прежде чем вы сможете использовать подпись отправителя. 2). Кроме того, это должен быть частный домен, к которому у вас есть доступ. Это необходимо по двум причинам. Во-первых, отправка писем Haskimail с домена, который вы не контролируете (например, Gmail или Yahoo), может расцениваться как email-спуфинг. Yahoo, в частности, опубликовала политику, запрещающую сторонним сервисам отправлять письма с адресов @yahoo.com. Во-вторых, у вас должна быть возможность изменять DNS-записи для добавления поддержки SPF и DKIM, которые настоятельно рекомендуются для повышения доставляемости писем.

Поле Name  также является обязательным при создании подписи отправителя. Это то, что большинство почтовых клиентов отобразят в поле «От кого». Хотя оно обязательно при создании подписи, его можно переопределить в каждом отдельном запросе. Если вы создадите подпись отправителя для «Nick <support@yourdomain.com>», вы также сможете отправлять письма от имени «Joe <support@yourdomain.com>» без каких-либо дополнительных настроек.

Поля ответа

Полный список полей ответа  находится здесь, но ниже приведены те поля, которые помогут вам в дальнейшей работе с подписями отправителей.

  • Поле ID используется, если вы захотите позже отредактировать или удалить подпись.
  • Поле  — это способ предоставить контекст получателю письма о том, что такое Haskimail. Это поле полезно, если вы отправляете письма от имени клиента, который может не знать, что вы используете Haskimail для отправки почты.
     
  • Поля DKIMPendingHost и DKIMPendingTextValue  — это значения, используемые для настройки DKIM для домена вашей подписи отправителя. DKIMPendingHost — это полный поддомен, где должен быть размещен ваш DKIM-ключ, а DKIMPendingTextValue — это значение, которое должно быть в TXT-записи DNS. После проверки DKIM эти значения переместятся в DKIMHost и DKIMTextValue.

Полное управление подписью отправителя #

Конечно, создание подписи отправителя — это лишь часть полного рабочего процесса. Используя эндпоинт API /senders, вы можете получать списки, редактировать или удалять свои подписи отправителей. Вы даже можете повторно отправить письмо-подтверждение, проверить SPF и запросить новые DKIM-ключи.