Email API

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

Поточний базовий шлях HTTP URI: https://fe.tiamati.email.

Всі кінцеві точки вимагають автентифікації за допомогою Basic Authorization. Ми підтримуємо два методи автентифікації:

API Token Authentication (Рекомендується для більшості кінцевих точок)

Встановіть свій API ключ як значення "username" з порожнім паролем:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Зверніть увагу на двокрапку (:) після API токена – це вказує на порожній пароль у форматі Basic Auth.

Alias Credentials Authentication (Для вихідної електронної пошти)

Кінцева точка Create outbound SMTP email також підтримує автентифікацію за допомогою вашої псевдонімної електронної адреси та згенерованого пароля псевдоніма:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Цей метод корисний при надсиланні електронних листів з додатків, які вже використовують SMTP облікові дані, і робить міграцію з SMTP на наш API безшовною.

Alias-Only Endpoints

Кінцеві точки Alias Contacts, Alias Calendars, Alias Messages та Alias Folders вимагають облікові дані псевдоніма і не підтримують автентифікацію за допомогою API токена.

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

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

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

Пагінація підтримується всіма кінцевими точками API, які повертають списки результатів.

Просто вкажіть параметри рядка запиту page (і за бажанням limit).

Параметр page повинен бути числом, більшим або рівним 1. Якщо ви вказуєте limit (також число), мінімальне значення – 10, а максимальне – 50 (якщо не зазначено інше).

Example Request:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Отримати логи

Наш API програмно дозволяє вам завантажувати логи для вашого облікового запису. Надсилання запиту до цього кінцевого пункту обробить усі логи вашого облікового запису та надішле їх вам електронною поштою у вигляді вкладення (стиснутий за допомогою Gzip файл CSV) після завершення.

Це дозволяє створювати фонові завдання за допомогою Cron job або використовуючи наше Node.js програмне забезпечення для планування завдань Bree, щоб отримувати логи коли завгодно. Зверніть увагу, що цей кінцевий пункт обмежений 10 запитами на день.

Вкладення має назву у нижньому регістрі email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz, а сама електронна пошта містить короткий звіт про отримані логи. Ви також можете завантажувати логи у будь-який час з Мій обліковий запис → Логи

GET /v1/logs/download

Example Request:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Приклад Cron job (щодня опівночі):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Зверніть увагу, що ви можете використовувати сервіси, такі як Crontab.guru, для перевірки синтаксису вашого виразу cron job.

Приклад Cron job (щодня опівночі і з логами за попередній день):

Для MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Для Linux та Ubuntu:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Створити обліковий запис

POST /v1/account

Example Request:

curl -X POST https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Отримати обліковий запис

GET /v1/account

Example Request:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Оновити обліковий запис

PUT /v1/account

Example Request:

curl -X PUT https://fe.tiamati.email/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

Скоро буде

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

Ці інструкції можна знайти у нашому розділі FAQ Чи підтримуєте ви отримання електронної пошти через 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://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Список вихідних SMTP листів

Зверніть увагу, що цей кінцевий пункт не повертає значення властивостей для message, headers або rejectedErrors листа.

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

GET /v1/emails

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

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Створити вихідний SMTP лист

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

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

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

Цей кінцевий пункт автоматично кодує емодзі, якщо вони знайдені в заголовках (наприклад, рядок теми Subject: 🤓 Hello автоматично конвертується в Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Наша мета — зробити максимально зручний для розробників і надійний API для листів.

Аутентифікація: Цей кінцевий пункт підтримує як аутентифікацію за API токеном, так і аутентифікацію за обліковими даними псевдоніма. Деталі див. у розділі Аутентифікація вище.

POST /v1/emails

Приклад запиту (API токен):

curl -X POST https://fe.tiamati.email/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://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Приклад запиту (Сирий Email):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Отримати вихідний SMTP лист

GET /v1/emails/:id

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

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Видалити вихідний SMTP лист

Видалення листа встановить статус у "rejected" (і відповідно не оброблятиме його в черзі) лише якщо поточний статус є одним із "pending", "queued" або "deferred". Ми можемо автоматично очищати листи через 30 днів після їх створення та/або відправлення – тому вам слід зберігати копію вихідних SMTP листів у вашому клієнті, базі даних або додатку. Ви можете посилатися на наше значення ID листа у вашій базі даних, якщо бажаєте – це значення повертається як з Створити лист, так і з Отримати лист кінцевих точок.

DELETE /v1/emails/:id

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

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

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

GET /v1/domains

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

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Створити домен

POST /v1/domains

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

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Отримати домен

GET /v1/domains/example.com

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

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

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

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

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

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

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

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

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

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Список паролів для домену з функцією catch-all

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

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

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Створити пароль catch-all для домену

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

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

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

Видалити пароль catch-all для домену

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

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Оновити домен

PUT /v1/domains/example.com

Example Request:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Видалити домен

DELETE /v1/domains/:domain_name

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Прийняти запрошення до домену

GET /v1/domains/:domain_name/invites

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Створити запрошення до домену

POST /v1/domains/example.com/invites

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Видалити запрошення до домену

DELETE /v1/domains/:domain_name/invites

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Оновити учасника домену

PUT /v1/domains/example.com/members/:member_id

Example Request:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Видалити учасника домену

DELETE /v1/domains/:domain_name/members/:member_id

Example Request:

curl -X DELETE https://fe.tiamati.email/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

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

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

GET /v1/domains/example.com/aliases

Example Request:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Створити новий псевдонім домену

POST /v1/domains/example.com/aliases

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Отримати псевдонім домену

Ви можете отримати псевдонім домену за його значенням id або name.

GET /v1/domains/:domain_name/aliases/:alias_id

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Оновити псевдонім домену

PUT /v1/domains/example.com/aliases/:alias_id

Example Request:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

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

DELETE /v1/domains/:domain_name/aliases/:alias_id

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Ми дозволяємо шифрувати записи навіть на безкоштовному плані безкоштовно. Конфіденційність не повинна бути функцією, вона має бути вбудована у всі аспекти продукту за замовчуванням. Як часто запитували в обговоренні Privacy Guides discussion та у наших GitHub issues, ми додали цю можливість.

Шифрувати TXT запис

POST /v1/encrypt

Example Request:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"