- Страница поиска
- Оглавление
API пересылки электронной почты
Библиотеки
На данный момент мы еще не выпустили никаких API-оболочек, но планируем сделать это в ближайшем будущем. Отправить электронное письмо на api@forwardemail.net если вы хотите получать уведомления о выпуске оболочки API определенного языка программирования. А пока вы можете использовать эти рекомендуемые библиотеки HTTP-запросов в своем приложении или просто использовать локон как в приведенных ниже примерах.
язык | Библиотека |
---|---|
Рубин | фарадей |
питон | Запросы |
Ява | OkHttp |
PHP | пропивать |
JavaScript | SuperAgent (мы сопровождающие) |
Node.js | SuperAgent (мы сопровождающие) |
Идти | нетто / HTTP |
.NET | RestSharp |
Базовый URI
Текущий базовый путь URI HTTP: https://api.forwardemail.net
.
Аутентификация
Все конечные точки требуют вашего ключ API для установки в качестве значения "имя пользователя" запроса Базовая авторизация заголовок. Не беспокойтесь — ниже приведены примеры, если вы не уверены, что это такое.
ошибки
Если возникают какие-либо ошибки, тело ответа на запрос API будет содержать подробное сообщение об ошибке.
Код | имя |
---|---|
200 | OK |
400 | Неверный запрос |
401 | неразрешенный |
403 | запрещено |
404 | не обнаружена |
429 | Слишком много запросов |
500 | Внутренняя Ошибка Сервера |
501 | Не реализована |
502 | Плохой шлюз |
503 | Сервис недоступен |
504 | Время ожидания шлюза |
локализация
Наш сервис переведен более чем на 25 различных языков. Все ответные сообщения API переводятся в последний обнаруженный языковой стандарт пользователя, отправляющего запрос API. Вы можете переопределить это, передав пользовательский Accept-Language
заголовок. Не стесняйтесь попробовать его, используя раскрывающийся список языков внизу этой страницы.
пагинация
Если вы хотите получить уведомление, когда будет доступна нумерация страниц, отправьте письмо по электронной почте. api@forwardemail.net.
Счет
создать учетную запись
POST /v1/account
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | да | Строка (электронная почта) | Адрес электронной почты |
password | да | строка | пароль |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Получить аккаунт
GET /v1/account
Пример запроса:
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Обновить аккаунт
PUT /v1/account
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | нет | Строка (электронная почта) | Адрес электронной почты |
given_name | нет | строка | Имя |
family_name | нет | строка | Фамилия |
avatar_url | нет | Строка (URL) | Ссылка на аватар |
Пример запроса:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Домены
/v1/domains/:domain_name
поскольку их путь взаимозаменяем с идентификатором домена :domain_id
. Это означает, что вы можете ссылаться на домен либо по его name
или id
ценность.
Список доменов
GET /v1/domains
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
name | нет | String (поддерживается RegExp) | Поиск доменов по имени |
alias | нет | String (поддерживается RegExp) | Поиск доменов по псевдониму |
recipient | нет | String (поддерживается RegExp) | Поиск доменов по получателю |
Пример запроса:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Создать домен
POST /v1/domains
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
domain | да | Строка (FQDN или IP) | Полное доменное имя («FQDN») или IP-адрес |
plan | нет | Строка (перечислимая) | Тип плана (должен быть "free" , "enhanced_protection" , или же "team" , по умолчанию "free" или текущий платный план пользователя, если он есть) |
catchall | нет | Строка (адреса электронной почты с разделителями) или логическое значение | Создайте универсальный псевдоним по умолчанию, по умолчанию true (если true он будет использовать адрес электронной почты пользователя API в качестве получателя, и если false универсального не будет). Если передается строка, то это список адресов электронной почты с разделителями для использования в качестве получателей (разделенных разрывом строки, пробелом и/или запятой). |
has_adult_content_protection | нет | логический | Включить ли защиту содержимого для взрослых с помощью Spam Scanner в этом домене |
has_phishing_protection | нет | логический | Включить ли защиту от фишинга Spam Scanner в этом домене |
has_executable_protection | нет | логический | Включить ли защиту исполняемого файла Spam Scanner в этом домене |
has_virus_protection | нет | логический | Включить ли защиту от вирусов Spam Scanner в этом домене |
has_recipient_verification | нет | логический | Глобальный домен по умолчанию для того, чтобы требовать, чтобы получатели псевдонимов щелкали ссылку подтверждения электронной почты для прохождения электронных писем. |
Пример запроса:
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 -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Проверить записи домена
GET /v1/domains/example.com/verify-records
Пример запроса:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Обновить домен
PUT /v1/domains/example.com
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
smtp_port | нет | Строка или номер | Пользовательский порт для настройки переадресации SMTP (по умолчанию "25" ) |
has_adult_content_protection | нет | логический | Включить ли защиту содержимого для взрослых с помощью Spam Scanner в этом домене |
has_phishing_protection | нет | логический | Включить ли защиту от фишинга Spam Scanner в этом домене |
has_executable_protection | нет | логический | Включить ли защиту исполняемого файла Spam Scanner в этом домене |
has_virus_protection | нет | логический | Включить ли защиту от вирусов Spam Scanner в этом домене |
has_recipient_verification | нет | логический | Глобальный домен по умолчанию для того, чтобы требовать, чтобы получатели псевдонимов щелкали ссылку подтверждения электронной почты для прохождения электронных писем. |
Пример запроса:
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 -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Создать домен приглашение
POST /v1/domains/example.com/invites
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | да | Строка (электронная почта) | Адрес электронной почты для приглашения в список участников домена |
group | да | Строка (перечислимая) | Группа для добавления пользователя в членство в домене (может быть одним из "admin" или "user" ) |
Пример запроса:
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
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | да | Строка (электронная почта) | Адрес электронной почты для удаления из списка членов домена |
Пример запроса:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
члены
Обновить члена домена
PUT /v1/domains/example.com/members/:member_id
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
group | да | Строка (перечислимая) | Группа для обновления членства пользователя в домене (может быть одним из "admin" или "user" ) |
Пример запроса:
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:
Псевдонимы
Список псевдонимов домена
GET /v1/domains/example.com/aliases
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
name | нет | String (поддерживается RegExp) | Искать алиасы в домене по имени |
recipient | нет | String (поддерживается RegExp) | Поиск псевдонимов в домене по получателю |
Пример запроса:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Создать новый псевдоним домена
POST /v1/domains/example.com/aliases
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
name | да | строка | Псевдоним |
recipients | да | Строка или Массив | Список получателей (должен быть строкой / пробелом / разделенным запятыми строкой или массивом допустимых адресов электронной почты, полными доменными именами («FQDN»), IP-адресами и / или URL-адресами веб-крюка) |
description | нет | строка | Описание псевдонима |
labels | нет | Строка или Массив | Список меток (должен быть через строку / пробел / через запятую, String или Array) |
has_recipient_verification | нет | логический | Включить ли требование, чтобы получатели щелкнули ссылку подтверждения электронной почты для прохождения электронной почты (по умолчанию используется настройка домена, если она не указана явно в тексте запроса) |
is_enabled | нет | логический | Включение или отключение этого псевдонима (если этот параметр отключен, электронные письма будут перенаправляться в никуда, но возвращать успешные коды состояния) |
Пример запроса:
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
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
name | нет | строка | Псевдоним |
recipients | да | Строка или Массив | Список получателей (должен быть строкой / пробелом / разделенным запятыми строкой или массивом допустимых адресов электронной почты, полными доменными именами («FQDN»), IP-адресами и / или URL-адресами веб-крюка) |
description | нет | строка | Описание псевдонима |
labels | нет | Строка или Массив | Список меток (должен быть через строку / пробел / через запятую, String или Array) |
has_recipient_verification | нет | логический | Включить ли требование, чтобы получатели щелкнули ссылку подтверждения электронной почты для прохождения электронной почты (по умолчанию используется настройка домена, если она не указана явно в тексте запроса) |
is_enabled | нет | логический | Включение или отключение этого псевдонима (если этот параметр отключен, электронные письма будут перенаправляться в никуда, но возвращать успешные коды состояния) |
Пример запроса:
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: