Email API

На данный момент мы еще не выпустили обертки для API, но планируем сделать это в ближайшем будущем. Отправьте письмо на api@forwardemail.net, если хотите получить уведомление о выпуске обертки API для конкретного языка программирования. Тем временем вы можете использовать эти рекомендуемые библиотеки HTTP-запросов в вашем приложении или просто использовать curl, как в приведенных ниже примерах.

Текущий базовый путь HTTP URI: https://fe.tiamati.email.

Все конечные точки требуют аутентификации с использованием Basic Authorization. Мы поддерживаем два метода аутентификации:

API Token Authentication (Рекомендуется для большинства конечных точек)

Установите ваш API ключ в качестве значения "username" с пустым паролем:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Обратите внимание на двоеточие (:) после API токена – это указывает на пустой пароль в формате Basic Auth.

Alias Credentials Authentication (Для исходящей почты)

Конечная точка Create outbound SMTP email также поддерживает аутентификацию с использованием вашего псевдонима электронной почты и сгенерированного пароля псевдонима:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Этот метод полезен при отправке писем из приложений, которые уже используют SMTP учетные данные, и обеспечивает бесшовную миграцию с SMTP на наш API.

Alias-Only Endpoints

Конечные точки Alias Contacts, Alias Calendars, Alias Messages и Alias Folders требуют учетных данных псевдонима и не поддерживают аутентификацию с помощью API токена.

Не волнуйтесь – ниже приведены примеры, если вы не уверены, что это такое.

Если возникнут ошибки, тело ответа API будет содержать подробное сообщение об ошибке.

Наш сервис переведен более чем на 25 языков. Все сообщения ответа API переводятся на последний обнаруженный язык пользователя, делающего запрос к API. Вы можете переопределить это, передав пользовательский заголовок Accept-Language. Не стесняйтесь попробовать, используя выпадающий список языков внизу этой страницы.

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

Просто укажите параметры строки запроса page (и опционально limit).

Параметр page должен быть числом, большим или равным 1. Если вы указываете limit (также число), минимальное значение — 10, максимальное — 50 (если не указано иное).

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

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Получение логов

Наш API программно позволяет вам скачать логи для вашей учетной записи. Отправка запроса на этот эндпоинт обработает все логи вашей учетной записи и отправит их вам по электронной почте в виде вложения (сжатого файла Gzip с CSV таблицей) после завершения.

Это позволяет создавать фоновые задачи с помощью Cron job или используя наше Node.js программное обеспечение для планирования задач Bree, чтобы получать логи когда угодно. Обратите внимание, что этот эндпоинт ограничен 10 запросами в день.

Вложение имеет имя в нижнем регистре email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz, а само письмо содержит краткое резюме полученных логов. Вы также можете скачать логи в любое время из Мой аккаунт → Логи

GET /v1/logs/download

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

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Пример Cron job (каждую ночь в полночь):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Обратите внимание, что вы можете использовать сервисы, такие как Crontab.guru, для проверки синтаксиса выражения cron job.

Пример Cron job (каждую ночь в полночь и с логами за предыдущий день):

Для MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Для Linux и Ubuntu:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Создать аккаунт

POST /v1/account

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

curl -X POST https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Получить аккаунт

GET /v1/account

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

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Обновить аккаунт

PUT /v1/account

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

curl -X PUT https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Список контактов

GET /v1/contacts

Скоро будет

Создать контакт

POST /v1/contacts

Скоро будет

Получить контакт

GET /v1/contacts/:id

Скоро будет

Обновить контакт

PUT /v1/contacts/:id

Скоро будет

Удалить контакт

DELETE /v1/contacts/:id

Скоро будет

Список календарей

GET /v1/calendars

Скоро будет

Создать календарь

POST /v1/calendars

Скоро будет

Получить календарь

GET /v1/calendars/:id

Скоро будет

Обновить календарь

PUT /v1/calendars/:id

Скоро будет

Удалить календарь

DELETE /v1/calendars/:id

Скоро будет

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

Эти инструкции можно найти в разделе FAQ Поддерживаете ли вы получение почты через IMAP?.

Список и поиск сообщений

GET /v1/messages

Скоро будет

Создать сообщение

POST /v1/messages

Скоро будет

Получить сообщение

GET /v1/messages/:id

Скоро будет

Обновить сообщение

PUT /v1/messages/:id

Скоро будет

Удалить сообщение

DELETE /v1/messages:id

Скоро будет

Список папок

GET /v1/folders

Скоро будет

Создать папку

POST /v1/folders

Скоро будет

Получить папку

GET /v1/folders/:id

Скоро будет

Обновить папку

PUT /v1/folders/:id

Скоро будет

Удалить папку

DELETE /v1/folders/:id

Скоро будет

Копировать папку

POST /v1/folders/:id/copy

Скоро будет

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

Эти инструкции можно найти в разделе Мой аккаунт → Домены → Настройки → Конфигурация исходящего SMTP. Вам необходимо настроить DKIM, Return-Path и DMARC для отправки исходящих SMTP писем с вашего домена.

Получить лимит исходящих SMTP писем

Это простой эндпоинт, который возвращает JSON-объект, содержащий count и limit для количества ежедневных исходящих SMTP сообщений на основе каждой учетной записи.

GET /v1/emails/limit

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

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Список исходящих SMTP писем

Обратите внимание, что этот эндпоинт не возвращает значения свойств для message, headers и rejectedErrors письма.

Чтобы получить эти свойства и их значения, используйте эндпоинт Получить письмо с ID письма.

GET /v1/emails

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

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Создать исходящее SMTP письмо

Наш API для создания письма вдохновлен и использует конфигурацию опций сообщения Nodemailer. Пожалуйста, обратитесь к конфигурации сообщения Nodemailer для всех параметров тела ниже.

Обратите внимание, что за исключением envelope и dkim (так как мы устанавливаем их автоматически для вас), мы поддерживаем все опции Nodemailer. Мы автоматически устанавливаем опции disableFileAccess и disableUrlAccess в true в целях безопасности.

Вы должны либо передать единственную опцию raw с вашим полным сырцовым письмом, включая заголовки, или передать отдельные параметры тела ниже.

Этот API автоматически кодирует эмодзи, если они встречаются в заголовках (например, строка темы Subject: 🤓 Hello автоматически преобразуется в Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Наша цель — сделать API для писем максимально удобным и защищённым для разработчиков.

Аутентификация: Этот эндпоинт поддерживает как аутентификацию по API токену, так и аутентификацию по учетным данным алиаса. Подробнее см. раздел Аутентификация выше.

POST /v1/emails

Пример запроса (API токен):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Пример запроса (учётные данные алиаса):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Пример запроса (сырой email):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Получить исходящее SMTP письмо

GET /v1/emails/:id

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

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Удалить исходящее SMTP письмо

Удаление письма установит статус в "rejected" (и впоследствии не будет обрабатывать его в очереди) только если текущий статус является одним из "pending", "queued" или "deferred". Мы можем автоматически удалять письма спустя 30 дней после их создания и/или отправки – поэтому вам следует хранить копию исходящих SMTP писем в вашем клиенте, базе данных или приложении. Вы можете ссылаться на наш идентификатор письма в вашей базе данных при необходимости – это значение возвращается как из Create email, так и из Retrieve email эндпоинтов.

DELETE /v1/emails/:id

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

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Список доменов

GET /v1/domains

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

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Создать домен

POST /v1/domains

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

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Получить домен

GET /v1/domains/example.com

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

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Проверить записи домена

GET /v1/domains/example.com/verify-records

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

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Проверить SMTP-записи домена

GET /v1/domains/example.com/verify-smtp

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

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Список паролей catch-all для всего домена

GET /v1/domains/example.com/catch-all-passwords

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

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Создать пароль catch-all для всего домена

POST /v1/domains/example.com/catch-all-passwords

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

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Удалить пароль catch-all для всего домена

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Обновить домен

PUT /v1/domains/example.com

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

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Удалить домен

DELETE /v1/domains/:domain_name

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Принять приглашение в домен

GET /v1/domains/:domain_name/invites

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

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Создать приглашение в домен

POST /v1/domains/example.com/invites

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

curl -X POST https://fe.tiamati.email/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Удалить приглашение в домен

DELETE /v1/domains/:domain_name/invites

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Обновить участника домена

PUT /v1/domains/example.com/members/:member_id

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

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Удалить участника домена

DELETE /v1/domains/:domain_name/members/:member_id

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Сгенерировать пароль для псевдонима

Обратите внимание, что если вы не отправите инструкции по электронной почте, то имя пользователя и пароль будут в теле JSON-ответа успешного запроса в формате { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

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

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Список псевдонимов домена

GET /v1/domains/example.com/aliases

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

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Создать новый псевдоним домена

POST /v1/domains/example.com/aliases

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Получить псевдоним домена

Вы можете получить псевдоним домена по его значению id или name.

GET /v1/domains/:domain_name/aliases/:alias_id

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Обновить псевдоним домена

PUT /v1/domains/example.com/aliases/:alias_id

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

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Удалить псевдоним домена

DELETE /v1/domains/:domain_name/aliases/:alias_id

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Мы позволяем вам шифровать записи даже на бесплатном тарифе без дополнительной платы. Конфиденциальность не должна быть функцией, она должна быть неотъемлемой частью всех аспектов продукта. По многочисленным просьбам в обсуждении Privacy Guides и в наших задачах на GitHub мы добавили эту возможность.

Шифрование TXT записи

POST /v1/encrypt

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

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"