API переадресації електронної пошти

Зміст

• Бібліотеки
• Базовий URI
• Аутентифікація
• Помилки
• Локалізація
• Пагинація
• Рахунок
  • Створити рахунок
  • Отримайте рахунок
  • Оновити обліковий запис
• Домени
  • Список доменів
  • Створіть домен
  • Отримайте домен
  • Перевірка записів домену
  • Оновіть домен
  • Видалити домен
• Запрошує
  • Прийняти запрошення домену
  • Створіть запрошення до домену
  • Видалити запрошення домену
• Члени
  • Оновити член домену
  • Видалити члена домену
• Псевдоніми
  • Перелік псевдонімів доменів
  • Створіть новий псевдонім домену
  • Отримати псевдонім домену
  • Оновіть псевдонім домену
  • Видалити псевдонім домену

Бібліотеки

Зараз ми ще не випустили жодної оболонки API, але плануємо зробити це найближчим часом. Надіслати електронний лист до api@forwardemail.net якщо ви хочете отримувати сповіщення, коли буде випущено оболонку API певної мови програмування. Тим часом ви можете використовувати ці рекомендовані бібліотеки запитів HTTP у своїй програмі або просто використовувати завиток як у наведених нижче прикладах.

Мова	Бібліотека
Рубін	Фарадей
Пітон	запити
Java	OkHttp
PHP	загадка
JavaScript	суперагент
Node.js	суперагент
Іди	net / http
.NET	RestSharp

Базовий URI

Поточний базовий шлях URI HTTP: https://api.forwardemail.net. Застарілий базовий шлях URI HTTP https://forwardemail.net:4000 не підтримується з 1 січня 2021 року.

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

Усі кінцеві точки вимагають вашого Ключ 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"

Домени

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

GET /v1/domains

Параметр запитів	вимагається	Тип	Опис
name	Ні	Рядок (підтримується RegExp)	Шукайте домени за назвою
alias	Ні	Рядок (підтримується RegExp)	Шукайте домени за псевдонімом
recipient	Ні	Рядок (підтримується 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	Ні	Булева	Увімкнути захист вмісту для дорослих у Сканері спаму в цьому домені
has_phishing_protection	Ні	Булева	Увімкнути захист від фішингу в сканері спаму в цьому домені
has_executable_protection	Ні	Булева	Увімкнути захист виконуваних файлів сканера спаму в цьому домені
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	Ні	Булева	Увімкнути захист вмісту для дорослих у Сканері спаму в цьому домені
has_phishing_protection	Ні	Булева	Увімкнути захист від фішингу в сканері спаму в цьому домені
has_executable_protection	Ні	Булева	Увімкнути захист виконуваних файлів сканера спаму в цьому домені
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

Параметр запитів	вимагається	Тип	Опис
name	Ні	Рядок (підтримується RegExp)	Шукайте псевдоніми в домені за іменем
recipient	Ні	Рядок (підтримується 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: