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

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

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

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

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

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

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

Пагінація підтримується всіма кінцевими точками 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) після завершення.

Це дозволяє створювати фонові завдання з 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"

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

GET /v1/contacts

Скоро

Створити контакт

POST /v1/contacts

Скоро

Отримати контакт

GET /v1/contacts/:id

Скоро

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

PUT /v1/contacts/:id

Скоро

Видалити контакт

DELETE /v1/contacts/:id

Скоро

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

GET /v1/calendars

Скоро

Створити календар

POST /v1/calendars

Скоро

Отримати календар

GET /v1/calendars/:id

Скоро

Оновити календар

PUT /v1/calendars/:id

Скоро

Видалити календар

DELETE /v1/calendars/:id

Скоро

Будь ласка, переконайтеся, що ви виконали інструкції з налаштування вашого домену.

Ці інструкції можна знайти в розділі поширених запитань Чи підтримується отримання електронної пошти через IMAP?.

Список та пошук повідомлень

GET /v1/messages

Скоро

Створити повідомлення

POST /v1/messages

Скоро

Отримати повідомлення

GET /v1/messages/:id

Скоро

Оновити повідомлення

PUT /v1/messages/:id

Скоро

Видалити повідомлення

DELETE /v1/messages:id

Скоро

Список папок

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:

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

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:

Перевірити SMTP-записи домену

GET /v1/domains/example.com/verify-smtp

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

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Список загальних паролів для домену

GET /v1/domains/example.com/catch-all-passwords

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

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Створити загальний пароль для домену

POST /v1/domains/example.com/catch-all-passwords

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

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Видалити загальний пароль для домену

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

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

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -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:

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

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"