API электронной почты

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

Текущий базовый путь HTTP URI: https://api.forwardemail.net.

Для всех конечных точек требуется, чтобы API-ключ был установлен в качестве значения «имя пользователя» заголовка Базовая авторизация запроса (за исключением Контакты псевдонима, Календари псевдонимов и Псевдонимы почтовых ящиков, которые используют сгенерированный псевдоним имени пользователя и пароля).

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

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

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

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

Просто укажите свойства строки запроса page (и при необходимости limit).

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

Чтобы определить, доступны ли дополнительные результаты, мы предоставляем следующие заголовки HTTP-ответа (которые можно проанализировать для программной пагинации):

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

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Извлечь журналы

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

Это позволяет создавать фоновые задания с Cron-задание или с использованием Программное обеспечение для планирования заданий Node.js Бри для получения журналов в любое удобное время. Обратите внимание, что эта конечная точка ограничена 10 запросами в день.

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

GET /v1/logs/download

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

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

Пример задания Cron (в полночь каждый день):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

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

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

Для MacOS:

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

Для Linux и Ubuntu:

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

Создать учетную запись

POST /v1/account

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

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

Получить учетную запись

GET /v1/account

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

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Обновление учетной записи

PUT /v1/account

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

curl -X PUT https://api.forwardemail.net/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

Вскоре

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

Эти инструкции можно найти в разделе часто задаваемых вопросов Поддерживаете ли вы получение электронной почты по протоколу 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://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

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

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

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

GET /v1/emails

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

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Создать исходящее SMTP-сообщение

Наш API для создания электронных писем основан на конфигурации параметров сообщений Nodemailer и использует её. Для всех параметров тела письма ниже используйте Конфигурация сообщения Nodemailer.

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

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

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

POST /v1/emails

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

curl -X POST https://api.forwardemail.net/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://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Получить исходящую SMTP-почту

GET /v1/emails/:id

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

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Удалить исходящее SMTP-сообщение

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

DELETE /v1/emails/:id

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

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

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

GET /v1/domains

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

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

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

POST /v1/domains

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

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

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

GET /v1/domains/example.com

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

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Проверка записей домена

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

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

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Проверка записей SMTP домена

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

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

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Вывести список паролей для всего домена

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

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

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

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

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

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

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

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

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

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

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

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

PUT /v1/domains/example.com

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

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

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

DELETE /v1/domains/:domain_name

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

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

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

GET /v1/domains/:domain_name/invites

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

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

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

POST /v1/domains/example.com/invites

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

curl -X POST https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Обновление члена домена

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

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

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

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

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

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

curl -X DELETE https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

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

GET /v1/domains/example.com/aliases

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

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

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

POST /v1/domains/example.com/aliases

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

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

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

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

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

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

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

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

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

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

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

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

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

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

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

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

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Зашифровать TXT-запись

POST /v1/encrypt

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

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"