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

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

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

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

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

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

[!СОВЕТ] Если вы получили код статуса 5xx (чего не должно быть), свяжитесь с нами по адресу api@forwardemail.net и мы поможем вам решить вашу проблему немедленно.

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

[!ПРИМЕЧАНИЕ] По состоянию на 1 ноября 2024 года конечные точки API для Список доменов а также Список псевдонимов домена по умолчанию будет 1000 максимальное количество результатов на странице. Если вы хотите заранее подписаться на это поведение, вы можете передать ?paginate=true как дополнительный параметр строки запроса к URL-адресу для запроса конечной точки.

Пагинация поддерживается всеми конечными точками 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 файл электронной таблицы) после завершения.

Это позволяет создавать фоновые задания с задание Крон или используя наш Программное обеспечение для планирования заданий Node.js Bree получать журналы в любое время. Обратите внимание, что эта конечная точка ограничена 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"

[!ПРИМЕЧАНИЕ] В отличие от других конечных точек API, эти требуют Аутентификация «username» равно псевдониму имени пользователя, а «password» равно паролю, сгенерированному псевдонимом, в качестве заголовков базовой авторизации.

[!ВНИМАНИЕ] Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.

[!NOTE] Поддержка CardDAV пока недоступна, следите за обновлениями в этом обсуждении на GitHub.

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

GET /v1/contacts

Скоро будет

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

POST /v1/contacts

Скоро будет

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

GET /v1/contacts/:id

Скоро будет

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

PUT /v1/contacts/:id

Скоро будет

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

DELETE /v1/contacts/:id

Скоро будет

[!ПРИМЕЧАНИЕ] В отличие от других конечных точек API, эти требуют Аутентификация «username» равно псевдониму имени пользователя, а «password» равно паролю, сгенерированному псевдонимом, в качестве заголовков базовой авторизации.

[!ВНИМАНИЕ] Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.

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

GET /v1/calendars

Скоро будет

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

POST /v1/calendars

Скоро будет

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

GET /v1/calendars/:id

Скоро будет

Календарь обновлений

PUT /v1/calendars/:id

Скоро будет

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

DELETE /v1/calendars/:id

Скоро будет

[!ПРИМЕЧАНИЕ] В отличие от других конечных точек API, эти требуют Аутентификация «username» равно псевдониму имени пользователя, а «password» равно паролю, сгенерированному псевдонимом, в качестве заголовков базовой авторизации.

[!ВНИМАНИЕ] Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.

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

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

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

GET /v1/messages

Скоро будет

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

[!ПРИМЕЧАНИЕ] Это будет NOT отправить электронное письмо – оно просто добавит сообщение в папку вашего почтового ящика (например, это похоже на IMAP) APPEND Команда). Если вы хотите отправить электронное письмо, см. Создать исходящее SMTP-сообщение ниже. После создания исходящего SMTP-письма вы можете прикрепить его копию, используя эту конечную точку, к почтовому ящику вашего псевдонима для хранения.

POST /v1/messages

Скоро будет

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

GET /v1/messages/:id

Скоро будет

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

PUT /v1/messages/:id

Скоро будет

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

DELETE /v1/messages:id

Скоро будет

[!TIP] Конечные точки папки с путем к папке /v1/folders/:path поскольку их конечная точка взаимозаменяема с идентификатором папки :id. Это означает, что вы можете ссылаться на папку либо по ее имени, path или id ценность.

[!ВНИМАНИЕ] Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.

Список папок

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 для всех параметров тела ниже.

Обратите внимание, что за исключением envelope а также dkim (поскольку мы устанавливаем их автоматически), мы поддерживаем все параметры Nodemailer. Мы автоматически устанавливаем 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:

[!TIP] Конечные точки домена с именем домена /v1/domains/:domain_name поскольку их конечная точка взаимозаменяема с идентификатором домена :domain_id. Это означает, что вы можете ссылаться на домен либо по его name или id ценность.

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

[!ПРИМЕЧАНИЕ] По состоянию на 1 ноября 2024 года конечные точки API для Список доменов а также Список псевдонимов домена по умолчанию будет 1000 максимальное количество результатов на странице. Если вы хотите заранее подписаться на это поведение, вы можете передать ?paginate=true как дополнительный параметр строки запроса к URL для запроса конечной точки. См. пагинация для большего понимания.

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:

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

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:

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

[!ПРИМЕЧАНИЕ] По состоянию на 1 ноября 2024 года конечные точки API для Список доменов а также Список псевдонимов домена по умолчанию будет 1000 максимальное количество результатов на странице. Если вы хотите заранее подписаться на это поведение, вы можете передать ?paginate=true как дополнительный параметр строки запроса к URL для запроса конечной точки. См. пагинация для большего понимания.

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"