API електронної пошти

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

Поточний базовий шлях URI HTTP: https://api.forwardemail.net.

Усі кінцеві точки вимагають вашого Ключ API має бути встановлено як значення "ім'я користувача" запиту Основна авторизація заголовок (за винятком Псевдонім Контакти, Календарі псевдонімів, і Псевдоніми поштових скриньок які використовують a створений псевдонім імені користувача та пароля)..

Не хвилюйтеся – нижче наведено приклади, якщо ви не впевнені, що це таке.

Якщо виникають помилки, тіло відповіді на запит 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 файл електронної таблиці) після завершення.

Це дозволяє створювати фонові завдання за допомогою a Робота Cron або за допомогою нашого Програмне забезпечення 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

Незабаром

[!ПОРАДА] Кінцеві точки папок із шляхом до папки /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:

[!ПОРАДА] Кінцеві точки домену з іменем домену /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:

Ми дозволяємо вам безкоштовно шифрувати записи навіть у безкоштовному плані. Конфіденційність не має бути функцією, вона має бути вбудованою в усі аспекти продукту. На настійне прохання в a Обговорення посібників із конфіденційності і далі наші проблеми GitHub ми додали це.

Зашифрувати запис TXT

POST /v1/encrypt

Приклад запиту:

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