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

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

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

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

Якщо виникають помилки, тіло відповіді на запит API міститиме детальне повідомлення про помилку.

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

Якщо ви бажаєте отримати сповіщення, коли стане доступною розбивка сторінок, надішліть електронний лист api@forwardemail.net.

Отримати журнали

Наш 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"

Будь ласка, переконайтеся, що ви виконали інструкції з налаштування для свого домену. Ці інструкції можна знайти за адресою Мій обліковий запис → Домени → Налаштування → Конфігурація вихідного SMTP. Вам потрібно налаштувати DKIM, Return-Path і DMARC для надсилання вихідних SMTP через ваш домен.

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

Зауважте, що ця кінцева точка не повертає вже створені електронні листи message, headers, accepted, ні rejectedErrors властивості.

Щоб повернути ці властивості та їхні значення, використовуйте Отримати електронну пошту кінцева точка з ідентифікатором електронної пошти.

Ця кінцева точка повернеться максимум 50 результати за один раз. Якщо ви хочете зробити запит для кількох сторінок, тоді додайте ?page=NUMBER де NUMBER є цілим числом, напр. ?page=1.

GET /v1/emails

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

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

Створити електронну пошту

Наш API для створення електронних листів натхненний конфігурацією параметрів повідомлень Nodemailer і використовує її. Будь ласка, відкладіть до Конфігурація повідомлень Nodemailer для всіх параметрів тіла нижче.

Зверніть увагу, що за винятком envelope і dkim (оскільки ми встановлюємо їх автоматично для вас), ми підтримуємо всі параметри Nodemailer. Ми встановлюємо автоматично disableFileAccess і disableUrlAccess варіанти до true з метою безпеки.

Ви повинні пройти один варіант raw із вашою необробленою повною електронною поштою, включаючи заголовки або передайте окремі параметри тіла нижче.

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`"

Отримати електронну пошту

GET /v1/emails/:id

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

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

Видалити електронну пошту

Видалення електронної пошти призведе до статусу "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:

Оновіть домен

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:

Перелік псевдонімів доменів

GET /v1/domains/example.com/aliases

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

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: