Перелік швидкої настройки
- Відкрийте сторінку API Management свого облікового запису та створіть свій особистий ключ API.
- Скопіюйте точну базову URL-адресу користувача API, показану там, наприклад https://v1.tempmailg.com/api.
- Надішліть кожен запит до цього хоста API з Authorization: Bearer YOUR_USER_API_KEY та Accept: application/json.
- Відстежуйте свою місячну квоту запитів на тій самій сторінці панелі управління та у заголовках квоти, коли вони доступні у відповідях API користувача. Тільки успішні запити з кодом 2xx враховуються в квоті.
Доступ до ключа API
Увійти, щоб створити свій особистий API-ключ та переглянути деталі живої квоти.
Потік автентифікації
- Згенеруйте свій особистий ключ API зі сторінки управління API у панелі управління.
- Надішліть ключ як токен Bearer у кожному запиті.
- Використовуйте спеціальний базовий URL користувача API, показаний на сторінці управління API.
- Регенеруйте ключ у будь-який момент, якщо хочете анулювати старий і почати використовувати новий ключ негайно.
Вимагані заголовки
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Заголовки обмеження швидкості та квоти
Заголовки обмеження швидкості описують зазначений бюджет запитів. Заголовки квоти включаються, коли доступна інформація про квоту; відхилення через обмеження за хвилину не враховують вашу повну місячну квоту.
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1729520000
X-Quota-Limit: 50000
X-Quota-Remaining: 48210
X-Quota-Used: 1790
X-Quota-Reset: 2026-11-01T00:00:00+00:00
X-RateLimit-Scope: account
Retry-After: 42 (when a timed retry is available)
X-RateLimit-Limit— Максимальна кількість запитів за хвилину (RPM) для вашого плану.X-RateLimit-Remaining— Залишилося запитів RPM у поточному хвилинному вікні.X-RateLimit-Reset— Unix‑мiтка часу, коли скидається поточне вікно ліміту швидкості за хвилину.X-Quota-Limit— Загальна місячна та придбана кредитна місткість вашого облікового запису.X-Quota-Remaining— Залишилося доступних запитів API у поточному місяці.X-Quota-Used— Загальна кількість запитів API, використаних протягом поточного платіжного періоду.X-Quota-Reset— ISO‑8601 мітка часу, коли скидається ваш місячний ліміт.X-RateLimit-Scope— Бюджет, описаний заголовками: account, ip, status_endpoint або mailbox.X-Mailbox-RateLimit-*— Окремий бюджет на створення/оновлення поштових скриньок. Успішні відповіді щодо поштових скриньок зберігають RPM облікового запису в X-RateLimit-*; відмова, що стосується лише скриньки, використовує область скриньки та власне вікно повторної спроби.Retry-After— Секунди, поки доцільна повторна спроба за таймером. Вимкнений план або вичерпана квота можуть вимагати зміни облікового запису, тому цей заголовок не завжди присутній.503 protection_unavailable— Захист API сховища або координація тимчасово недоступна. Спробуйте пізніше; це не помилка платежу або списання кредиту.
Керування поштовою скринькою
Отримати дозволені домени, створювати або переключати поштові скриньки, вибирати дозволені терміни дії, та видаляти власні адреси.
Список дозволених доменів
Перерахуйте доступні домени для створення тимчасових електронних листів. Фільтруйте за типом, щоб бачити лише безкоштовні, преміум або кастомні домени, підтримувані вашим планом підписки.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
type
|
query | string | необов'язковий |
Фільтр рівня домену. При пропуску використовується всі, коли доступ до преміум-домену увімкнено, інакше безкоштовний. Визнані значення: free, basic, pro, premium, custom, ultimate, all
За замовчуванням:
Залежить від облікового запису
|
const response = await fetch('https://v1.tempmailg.com/api/domains?type=free', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/domains?type=free', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/domains?type=free');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/domains?type=free' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"requested_type": "free",
"plan": "pro",
"plan_name": "Pro Plan",
"allowed_types": [
"free",
"basic",
"pro",
"premium",
"custom",
"ultimate",
"all"
],
"domains": [
{
"domain": "example.com",
"type": "Free",
"custom": false
}
]
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.requested_type |
string | Застосовано фільтр домену. |
data.plan |
string | Тег поточного плану. |
data.plan_name |
string | Зручна назва поточного плану. |
data.allowed_types |
array<string> | Фільтри домену, доступні цьому обліковому запису. Визнаний фільтр все ще може бути заборонений у вашому плані. |
data.domains |
array | Вибрані домени після фільтрації; порожній масив є допустимим. |
data.domains[].domain |
string | Вибиране доменне ім'я. |
data.domains[].type |
string | Мітка рівня домену, що читається. |
data.domains[].custom |
boolean | Чи є це власним доменом. |
Створити тимчасову скриньку
Створіть власну тимчасову поштову скриньку. Приберіть ім'я користувача та домен для випадкової генерації, або вкажіть дозволене користувацьке ім'я та дозволений домен. Параметр provider може вибирати генерацію псевдоніма Gmail або Outlook.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
username
|
body | string | необов'язковий |
Опціональне власне ім'я користувача: від 2 до 64 ASCII‑літер, цифр, крапок, підкреслень або дефісів. Потрібен дозвіл плану; також приймається custom_username.
За замовчуванням:
Випадково згенеровано
|
domain
|
body | string | необов'язковий |
Один із дозволених доменів, повернутих GET /domains. При пропуску вибирається випадковий дозволений домен.
За замовчуванням:
Випадковий дозволений домен
|
lifetime
|
body | string | необов'язковий |
допустимі значення:
10m — 10 хвилин
1h — 1 Година
2h — 2 Години
1d — 1 день
1w — 1 Тиждень
1m — 30 днів
3m — 90 днів
6m — 180 днів
1y — 365 днів
unlimited — Необмежено
За замовчуванням:
Термін дії плану за замовчуванням
|
provider
|
body | string | необов'язковий |
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
За замовчуванням:
standard
|
pin_enabled
|
body | boolean | необов'язковий |
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням:
false
|
pin
|
body | string | необов'язковий |
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
|
pin_confirmation
|
body | string | необов'язковий |
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
|
Idempotency-Key
|
header | string | необов'язковий |
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
|
username (користувацьке ім'я, якщо дозволено планом), domain (дозволений домен, напр. example.com), lifetime (допустимі значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.const response = await fetch('https://v1.tempmailg.com/api/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/emails', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/emails');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/emails' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"id": 2301,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-20T02:18:06+00:00",
"expires_in_seconds": 86399.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.id |
integer | Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки. |
data.pin_protected |
boolean | Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються. |
data.email |
string | Згенеровано повну адресу поштової скриньки. |
data.domain |
string | Домен створеної поштової скриньки. |
data.provider |
string | Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias. |
data.expire_at |
string|null | Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки. |
data.expires_in_seconds |
number|null | Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль. |
data.mailbox_state |
string | Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний. |
data.receiving_enabled |
boolean | Чи ця поштовий ящик наразі приймає вхідні повідомлення. |
data.message_count |
integer | Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки. |
data.unread_message_count |
integer | Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки. |
data.last_message_received_at |
string|null | Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно. |
data.message_count_synced_at |
string|null | Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації. |
data.created_at |
string|null | Час створення поштової скриньки у форматі ISO-8601. |
data.email_token |
string | Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN. |
data.pin_grant |
object | Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає. |
data.pin_grant.mailbox_id |
integer | ID поштової скриньки, до якої прив’язано умовне право читання. |
data.pin_grant.unlock_token |
string | Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення. |
data.pin_grant.scope |
string | Область, прочитана для умовного гранту створення. |
data.pin_grant.idle_timeout_seconds |
integer | Дозволений час простою для права читання, зазвичай 3600 секунд. |
data.pin_grant.absolute_timeout_seconds |
integer | Максимальний термін дії гранту на читання, зазвичай 86400 секунд. |
data.pin_grant.expires_at |
string | Термін дії поточного дозволу на читання у форматі ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше. |
Оновити / Перемкнути поштову скриньку
Створіть або виберіть поштову скриньку за новим ім'ям користувача та доменом після підтвердження володіння поточною скринькою. Це не перейменовує стару скриньку і не змінює її термін дії на місці. Якщо пункт призначення відрізняється, стара скринька залишається в історії і може бути призупинена обмеженнями активних скриньок. Повторне використання вашого власного активного пункту призначення застосовує його запитаний термін дії або типове значення плану.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
email
|
path | string | обов’язкове |
Поточна повна електронна адреса власної поштової скриньки для переключення. URL‑кодуйте кожен сегмент шляху; кодуйте знак плюс як %2B.
|
username
|
path | string | обов’язкове |
Новий бажаний логін: 2–64 алфавітно-цифрових символів; залежить від дозволу на кастомні імена користувачів.
|
domain
|
path | string | обов’язкове |
Нове дозволене доменне ім'я.
|
lifetime
|
body | string | необов'язковий |
допустимі значення:
10m — 10 хвилин
1h — 1 Година
2h — 2 Години
1d — 1 день
1w — 1 Тиждень
1m — 30 днів
3m — 90 днів
6m — 180 днів
1y — 365 днів
unlimited — Необмежено
За замовчуванням:
Термін дії плану за замовчуванням
|
pin_enabled
|
body | boolean | необов'язковий |
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням:
false
|
pin
|
body | string | необов'язковий |
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
|
pin_confirmation
|
body | string | необов'язковий |
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
|
Idempotency-Key
|
header | string | необов'язковий |
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
|
X-Mailbox-Unlock
|
header | string | необов'язковий |
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (дозволені значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.const response = await fetch('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"id": 2302,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-19T02:28:06+00:00",
"expires_in_seconds": 599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.id |
integer | Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки. |
data.pin_protected |
boolean | Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються. |
data.email |
string | Згенеровано повну адресу поштової скриньки. |
data.domain |
string | Домен створеної поштової скриньки. |
data.provider |
string | Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias. |
data.expire_at |
string|null | Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки. |
data.expires_in_seconds |
number|null | Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль. |
data.mailbox_state |
string | Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний. |
data.receiving_enabled |
boolean | Чи ця поштовий ящик наразі приймає вхідні повідомлення. |
data.message_count |
integer | Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки. |
data.unread_message_count |
integer | Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки. |
data.last_message_received_at |
string|null | Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно. |
data.message_count_synced_at |
string|null | Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації. |
data.created_at |
string|null | Час створення поштової скриньки у форматі ISO-8601. |
data.email_token |
string | Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN. |
data.pin_grant |
object | Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає. |
data.pin_grant.mailbox_id |
integer | ID поштової скриньки, до якої прив’язано умовне право читання. |
data.pin_grant.unlock_token |
string | Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення. |
data.pin_grant.scope |
string | Область, прочитана для умовного гранту створення. |
data.pin_grant.idle_timeout_seconds |
integer | Дозволений час простою для права читання, зазвичай 3600 секунд. |
data.pin_grant.absolute_timeout_seconds |
integer | Максимальний термін дії гранту на читання, зазвичай 86400 секунд. |
data.pin_grant.expires_at |
string | Термін дії поточного дозволу на читання у форматі ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше. |
Видалити поштову скриньку
Видалити власну поштову скриньку та ініціювати очищення її повідомлень і файлів. Збережені записи поштових скриньок можуть бути м'яко видалені внутрішньо; адреса більше не доступна через API.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
email
|
path | string | обов’язкове |
Повна електронна адреса власної поштової скриньки, яку потрібно видалити. URL‑кодуйте адресу; плюс‑знак кодуйте як %2B.
|
X-Mailbox-Unlock
|
header | string | необов'язковий |
Заголовок, лише захищені поштові скриньки: використовуйте одноразовий токен розблокування видалення. Спочатку POST pin, scope=delete і action/target_id, що повертаються у відповіді 423 на URL розблокування PIN. Токен читання не може видаляти. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | необов'язковий |
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
|
const response = await fetch('https://v1.tempmailg.com/api/emails/demo123@example.com', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.delete('https://v1.tempmailg.com/api/emails/demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/emails/demo123@example.com');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request DELETE \
--url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
message |
string | Результат видалення. Відсутній ресурс повертає HTTP 404. |
Gmail & Outlook псевдоніми
Створюйте поштові скриньки‑аліаси Gmail та Outlook/Hotmail з високою репутацією.
Створити псевдонім Gmail
Створити нову тимчасову поштову скриньку‑аліас Gmail, що належить автентифікованому користувачеві.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
mode
|
body | string | необов'язковий |
Режим генерації: auto, dot, plus або plus_dot. Також приймає gmail_alias_mode. Якщо вибір стилю не дозволений, використовується auto.
За замовчуванням:
auto
|
username
|
body | string | необов'язковий |
Необов'язковий власний суфікс псевдоніма: 2 до 32 ASCII‑літер або цифр, нормалізованих до нижнього регістру; залежить від дозволу функції. Також приймає custom_username або alias_username.
За замовчуванням:
Автогенеровано
|
domain
|
body | string | необов'язковий |
Використовуйте випадковий, gmail.com або googlemail.com; також приймається alias_domain. При пропуску або недоступному дозволі вибору домену використовується випадковий.
За замовчуванням:
random
|
lifetime
|
body | string | необов'язковий |
допустимі значення:
10m — 10 хвилин
1h — 1 Година
2h — 2 Години
1d — 1 день
1w — 1 Тиждень
1m — 30 днів
3m — 90 днів
6m — 180 днів
1y — 365 днів
unlimited — Необмежено
За замовчуванням:
Термін дії плану за замовчуванням
|
pin_enabled
|
body | boolean | необов'язковий |
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням:
false
|
pin
|
body | string | необов'язковий |
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
|
pin_confirmation
|
body | string | необов'язковий |
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
|
Idempotency-Key
|
header | string | необов'язковий |
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
|
mode (auto, dot, plus, plus_dot), username (користувач з власним псевдонімом), domain (наприклад, gmail.com, googlemail.com), lifetime (допустимі значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.const response = await fetch('https://v1.tempmailg.com/api/gmail-alias/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/gmail-alias/emails', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/gmail-alias/emails');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"id": 2305,
"pin_protected": false,
"email": "example+alias123@gmail.com",
"domain": "gmail.com",
"provider": "gmail_alias",
"expire_at": "2026-11-19T03:18:06+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.id |
integer | Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки. |
data.pin_protected |
boolean | Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються. |
data.email |
string | Згенеровано повну адресу поштової скриньки. |
data.domain |
string | Домен створеної поштової скриньки. |
data.provider |
string | Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias. |
data.expire_at |
string|null | Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки. |
data.expires_in_seconds |
number|null | Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль. |
data.mailbox_state |
string | Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний. |
data.receiving_enabled |
boolean | Чи ця поштовий ящик наразі приймає вхідні повідомлення. |
data.message_count |
integer | Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки. |
data.unread_message_count |
integer | Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки. |
data.last_message_received_at |
string|null | Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно. |
data.message_count_synced_at |
string|null | Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації. |
data.created_at |
string|null | Час створення поштової скриньки у форматі ISO-8601. |
data.email_token |
string | Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN. |
data.pin_grant |
object | Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає. |
data.pin_grant.mailbox_id |
integer | ID поштової скриньки, до якої прив’язано умовне право читання. |
data.pin_grant.unlock_token |
string | Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення. |
data.pin_grant.scope |
string | Область, прочитана для умовного гранту створення. |
data.pin_grant.idle_timeout_seconds |
integer | Дозволений час простою для права читання, зазвичай 3600 секунд. |
data.pin_grant.absolute_timeout_seconds |
integer | Максимальний термін дії гранту на читання, зазвичай 86400 секунд. |
data.pin_grant.expires_at |
string | Термін дії поточного дозволу на читання у форматі ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше. |
Псевдоніми доменів Outlook
Отримати активні домени псевдонімів Outlook / Hotmail, доступні для створення поштових скриньок.
const response = await fetch('https://v1.tempmailg.com/api/outlook-alias/domains', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/outlook-alias/domains', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/outlook-alias/domains');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"domains": [
{
"domain": "outlook.com",
"type": "Outlook/Hotmail",
"selectable": true,
"locked": false,
"disabled_reason": null
},
{
"domain": "hotmail.com",
"type": "Outlook/Hotmail",
"selectable": true,
"locked": false,
"disabled_reason": null
}
]
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.domains |
array | Активні домени Outlook/Hotmail; порожній масив є допустимим. |
data.domains[].domain |
string | Доступне доменне ім'я. |
data.domains[].type |
string | Читабельна мітка постачальника. |
data.domains[].selectable |
boolean | Чи може ваш обліковий запис явно вибрати цей домен. |
data.domains[].locked |
boolean | Чи заблоковано явний вибір домену у вашому обліковому записі. |
data.domains[].disabled_reason |
string|null | Причина, чому вибір домену заблоковано, або null, коли вибір можливий. |
Створити псевдонім Outlook
Створити нову Outlook / Hotmail тимчасову поштову скриньку‑аліас, що належить автентифікованому користувачеві.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
domain
|
body | string | необов'язковий |
Використовуйте випадковий або домен з GET /outlook-alias/domains; також приймається outlook_alias_domain. Якщо немає дозволу на вибір, використовується випадковий.
За замовчуванням:
Випадковий доступний домен
|
username
|
body | string | необов'язковий |
Необов'язковий власний суфікс псевдоніма: 2 до 32 ASCII‑літер або цифр, нормалізованих до нижнього регістру; залежить від дозволу функції. Також приймає custom_username або alias_username.
За замовчуванням:
Автогенеровано
|
lifetime
|
body | string | необов'язковий |
допустимі значення:
10m — 10 хвилин
1h — 1 Година
2h — 2 Години
1d — 1 день
1w — 1 Тиждень
1m — 30 днів
3m — 90 днів
6m — 180 днів
1y — 365 днів
unlimited — Необмежено
За замовчуванням:
Термін дії плану за замовчуванням
|
pin_enabled
|
body | boolean | необов'язковий |
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням:
false
|
pin
|
body | string | необов'язковий |
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
|
pin_confirmation
|
body | string | необов'язковий |
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
|
Idempotency-Key
|
header | string | необов'язковий |
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
|
domain (наприклад, outlook.com, hotmail.com), username (користувач з власним псевдонімом), lifetime (допустимі значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.const response = await fetch('https://v1.tempmailg.com/api/outlook-alias/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/outlook-alias/emails', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/outlook-alias/emails');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"id": 2306,
"pin_protected": false,
"email": "example+alias45@outlook.com",
"domain": "outlook.com",
"provider": "outlook_alias",
"expire_at": "2026-11-19T03:18:06+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.id |
integer | Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки. |
data.pin_protected |
boolean | Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються. |
data.email |
string | Згенеровано повну адресу поштової скриньки. |
data.domain |
string | Домен створеної поштової скриньки. |
data.provider |
string | Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias. |
data.expire_at |
string|null | Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки. |
data.expires_in_seconds |
number|null | Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль. |
data.mailbox_state |
string | Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний. |
data.receiving_enabled |
boolean | Чи ця поштовий ящик наразі приймає вхідні повідомлення. |
data.message_count |
integer | Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки. |
data.unread_message_count |
integer | Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки. |
data.last_message_received_at |
string|null | Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно. |
data.message_count_synced_at |
string|null | Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації. |
data.created_at |
string|null | Час створення поштової скриньки у форматі ISO-8601. |
data.email_token |
string | Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN. |
data.pin_grant |
object | Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає. |
data.pin_grant.mailbox_id |
integer | ID поштової скриньки, до якої прив’язано умовне право читання. |
data.pin_grant.unlock_token |
string | Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення. |
data.pin_grant.scope |
string | Область, прочитана для умовного гранту створення. |
data.pin_grant.idle_timeout_seconds |
integer | Дозволений час простою для права читання, зазвичай 3600 секунд. |
data.pin_grant.absolute_timeout_seconds |
integer | Максимальний термін дії гранту на читання, зазвичай 86400 секунд. |
data.pin_grant.expires_at |
string | Термін дії поточного дозволу на читання у форматі ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше. |
Повідомлення та вкладення
Отримуйте вхідні поштові скриньки, читайте повні HTML/текстові повідомлення та транслюйте вкладення.
Список повідомлень поштової скриньки
Отримайте доступні підсумки повідомлень та метадані поштової скриньки. Стандартне сканування вхідних повідомлень повертає недавню порцію до 25 повідомлень; це не пагінована кінцева точка повної історії. Використовуйте GET /messages/{messageId} для повних тіл повідомлень та вкладень.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
email
|
query | string | обов’язкове |
Повна електронна адреса власної поштової скриньки, з якої читати повідомлення. URL-кодуйте значення запиту; кодуйте знак плюс як %2B.
|
X-Mailbox-Unlock
|
header | string | необов'язковий |
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
const response = await fetch('https://v1.tempmailg.com/api/messages?email=demo123@example.com', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/messages?email=demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/messages?email=demo123@example.com');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"mailbox": "demo123@example.com",
"email_token": "encrypted-email-token",
"messages": [
{
"is_seen": false,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"receivedAt": "2026-11-19 02:18:06",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"otp": null,
"otp_locked": false,
"verification_link": null,
"verification_link_locked": false
}
],
"mailbox_provider": "standard",
"mailbox_state": "active",
"expire_at": "2026-11-20T02:18:06+00:00",
"expires_in_seconds": 86399.75,
"receiving_enabled": true,
"mailbox_limit": {
"limit": 50,
"limit_label": "50",
"active_count": 1,
"paused_count": 0,
"paused_mailboxes": [],
"remaining": 49,
"remaining_label": "49",
"reached": false,
"blocked": false,
"provider": "standard"
},
"message_count": 1,
"unread_message_count": 1,
"last_message_received_at": "2026-11-19T02:18:06+00:00",
"message_count_synced_at": "2026-11-19T02:18:06+00:00"
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
mailbox |
string | Адреса поштової скриньки, повідомлення якої були запитані. |
email_token |
string | Непрозоре зашифроване посилання на поштову скриньку; звичайна автентифікація все ще потрібна. |
mailbox_provider |
string | Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias. |
messages |
array | Резюме повідомлень. Порожня вхідна скринька повертає порожній масив; отримайте одне повідомлення для його вмісту та вкладень. |
expire_at |
string|null | Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки. |
expires_in_seconds |
number|null | Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль. |
mailbox_state |
string | Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний. |
receiving_enabled |
boolean | Чи ця поштовий ящик наразі приймає вхідні повідомлення. |
message_count |
integer | Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки. |
unread_message_count |
integer | Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки. |
last_message_received_at |
string|null | Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно. |
message_count_synced_at |
string|null | Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації. |
mailbox_limit.limit |
integer | Ліміт активних поштових скриньок для цього провайдера; -1 означає безліміт. |
mailbox_limit.limit_label |
string | Мітка відображення для ліміту поштової скриньки. |
mailbox_limit.active_count |
integer | Кількість активних поштових скриньок для цього провайдера. |
mailbox_limit.paused_count |
integer | Кількість призупинених поштових скриньок для цього провайдера. |
mailbox_limit.paused_mailboxes |
array<string> | Адреси призупинені через обмеження поштової скриньки. |
mailbox_limit.remaining |
integer | Залишилося активних слотів поштових скриньок; -1 означає безліміт. Це не квота запитів API. |
mailbox_limit.remaining_label |
string | Показати мітку для залишкових слотів поштової скриньки. |
mailbox_limit.reached |
boolean | Чи досягнуто ліміту активних поштових скриньок. |
mailbox_limit.blocked |
boolean | Чи дорівнює активне обмеження поштових скриньок нулю. |
mailbox_limit.provider |
string|null | Провайдер, до якого застосовується обмеження поштової скриньки. |
messages[].id |
string | Непрозорий ідентифікатор повідомлення, що використовується кінцевими точками для окремого повідомлення, видалення та вкладення. |
messages[].is_seen |
boolean | Чи позначено повідомлення як прочитане. |
messages[].subject |
string | Тема повідомлення. |
messages[].from |
string | Відображуване ім'я або адреса відправника. |
messages[].from_email |
string | Адреса електронної пошти відправника. |
messages[].receivedAt |
string | Час отримання у часовому поясі застосунку, у форматі YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Виявлено одноразовий код, коли доступний і дозволений; інакше null. |
messages[].otp_locked |
boolean | Чи приховано виявлений одноразовий код за допомогою дозволів функції. |
messages[].verification_link |
string|null | Виявлено URL-адресу перевірки, коли вона доступна та дозволена; інакше null. |
messages[].verification_link_locked |
boolean | Чи приховано виявлене посилання для підтвердження за допомогою дозволів функції. |
messages[].from_name |
string|null | Поле підсумку Outlook: ім'я оригінального відправника. Відсутнє у стандартних та Gmail підсумках. |
messages[].snippet |
string|null | Поле підсумку Outlook: короткий перегляд повідомлення. |
messages[].received_at |
string|null | Поле підсумку Outlook: час отримання у форматі ISO-8601, якщо відомо. |
messages[].has_attachments |
boolean | Поле підсумку Outlook: чи існує метадані вкладень. Доступність завантаження перевіряється окремо. |
Отримати одне повідомлення
Отримати власне повідомлення за його непрозорим ідентифікатором повідомлення. Повертає формати тіла та метадані вкладень. Поля тіла залежать від формату повідомлення; Outlook додає специфічні для провайдера поля, перелічені нижче.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
messageId
|
path | string | обов’язкове |
Унікальний ідентифікатор повідомлення, що повертається у списку повідомлень.
|
X-Mailbox-Unlock
|
header | string | необов'язковий |
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"data": {
"is_seen": true,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"to": "demo123@example.com",
"mailbox_provider": "standard",
"receivedAt": "2026-11-19 02:18:06",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"html": true,
"html_content": "<p>Hello from the inbox.</p>",
"text_content": "<pre>Hello from the inbox.</pre>",
"content": "<p>Hello from the inbox.</p>",
"attachments": [
{
"name": "file.txt",
"extension": "txt",
"size": 91,
"url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
}
]
}
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
data.id |
string | Непрозорий ідентифікатор повідомлення. |
data.is_seen |
boolean | Стан прочитання повідомлення. Читання може позначити його як переглянуте; кешовані дані можуть відображати попередній стан. |
data.subject |
string | Тема повідомлення. |
data.from |
string | Відображуване ім'я або адреса відправника. |
data.from_email |
string | Адреса електронної пошти відправника. |
data.to |
string | Адреса поштової скриньки одержувача. |
data.mailbox_provider |
string | Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias. |
data.receivedAt |
string | Час отримання у часовому поясі застосунку, у форматі YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Чи має повідомлення HTML‑тіло. |
data.html_content |
string | HTML‑тіло, коли присутнє. Стандартні повідомлення без HTML можуть пропускати це поле. Ставтеся до вмісту повідомлення як до ненадійного. |
data.text_content |
string | Текстове тіло, коли присутнє; Стандартні повідомлення можуть містити екранований текст у елементі pre або пропускати це поле. |
data.content |
string | Бажане тіло для відображення, зазвичай HTML, якщо доступно. |
data.attachments |
array | Метадані вкладення, або порожній масив. Завантаження вимагають звичайної автентифікації та відповідної авторизації PIN. |
data.attachments[].name |
string | Ім'я файлу для URL-кодування як один сегмент шляху під час завантаження. |
data.attachments[].size |
integer | Розмір вкладення в байтах. |
data.attachments[].url |
string | URL-адресу завантаження API автентифікованого користувача додано до вкладень з ім'ям файлу. URL-адреса не гарантує, що локальний файл доступний. |
data.attachments[].extension |
string | Стандартне/поле метаданих Gmail: розширення файлу, якщо вказано. |
data.attachments[].id |
string | Поле метаданих Outlook: ідентифікатор вкладення постачальника. |
data.attachments[].content_type |
string | Поле метаданих Outlook: MIME‑тип вмісту. |
data.from_name |
string|null | Поле деталізації Outlook: ім'я оригінального відправника. |
data.to_email |
string|null | Поле деталізації Outlook: адреса оригінального отримувача. |
data.received_at |
string|null | Поле деталізації Outlook: час отримання у форматі ISO-8601. |
data.has_html |
boolean | Поле деталізації Outlook: чи існує HTML‑тіло. |
Видалити повідомлення
Видалити одне повідомлення, що належить користувачеві
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
messageId
|
path | string | обов’язкове |
Унікальний рядок ідентифікатора повідомлення для постійного видалення.
|
X-Mailbox-Unlock
|
header | string | необов'язковий |
Заголовок, лише захищені поштові скриньки: використовуйте одноразовий токен розблокування видалення. Спочатку POST pin, scope=delete і action/target_id, що повертаються у відповіді 423 на URL розблокування PIN. Токен читання не може видаляти. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | необов'язковий |
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
|
const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.delete('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request DELETE \
--url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Поле | Тип | Опис |
|---|---|---|
status |
boolean | Чи успішна операція. |
message |
string | Результат видалення. Відсутній ресурс повертає HTTP 404. |
Завантажити вкладення
Завантажити вкладення з повідомлення, яким ви володієте.
| Параметр | Місцезнаходження | Тип | Статус | Опис |
|---|---|---|---|---|
messageId
|
path | string | обов’язкове |
Ідентифікатор повідомлення, що містить файл.
|
filename
|
path | string | обов’язкове |
Ім'я файлу та розширення вкладення для завантаження.
|
X-Mailbox-Unlock
|
header | string | необов'язковий |
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const blob = await response.blob();
const downloadUrl = window.URL.createObjectURL(blob);
const link = document.createElement('a');
link.href = downloadUrl;
link.download = 'file.txt';
document.body.appendChild(link);
link.click();
link.remove();
window.URL.revokeObjectURL(downloadUrl);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', headers=headers, stream=True, timeout=30)
response.raise_for_status()
with open('file.txt', 'wb') as handle:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
handle.write(chunk)
<?php
$fileHandle = fopen('file.txt', 'w');
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_FILE => $fileHandle,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
if (curl_exec($ch) === false) {
fclose($fileHandle);
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
fclose($fileHandle);
curl --request GET \
--url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY' \
--output file.txt
| Поле | Тип | Опис |
|---|---|---|
Content-Disposition |
header | Успішна відповідь завантажує запитане ім'я файлу. |
body |
binary | Байти файлу у випадку успіху, а не JSON. Помилки повертають JSON зі статусом, відмінним від 2xx. |
Ліміти швидкості та квоти
Контролюйте бюджети запитів у реальному часі, обмеження швидкості та квоти облікового запису без використання кредитів.
Обмеження швидкості та квота
Перевірте ваш поточний ліміт запитів та статус квоти без споживання будь‑якого використання API. Цей кінцевий пункт не враховує квоту і не знімає місячні кредити API (обмеження захисту від зловживань: 60 запитів/хв).
const response = await fetch('https://v1.tempmailg.com/api/rate-limit', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/rate-limit', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/rate-limit');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/rate-limit' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.
Приклад відповіді
200 OK • JSON{
"status": "success",
"data": {
"limit": 60,
"remaining": 45,
"reset": 32,
"plan": "premium",
"monthly_limit": 50000,
"monthly_remaining": 48210,
"purchased_credits": 5000,
"quota": {
"enabled": true,
"user_api_status": true,
"plan_name": "Premium Plan",
"period": "2026-10",
"base_limit": 50000,
"extra_requests": 0,
"monthly_limit": 50000,
"monthly_remaining": 48210,
"used": 1790,
"purchased_credits": 5000,
"bonus_credits": 1000,
"direct_purchased_credits": 4000,
"remaining": 53210,
"unlimited": false,
"usage_percent": 3,
"reset_at": "2026-11-01T00:00:00+00:00"
}
}
}
| Поле | Тип | Опис |
|---|---|---|
data.limit |
integer|string | Ліміт запитів облікового запису за хвилину. Рядок unlimited позначає необмежений хвилинний бюджет; це незалежно від місячної квоти. |
data.remaining |
integer|string | Залишкові слоти хвилинного бюджету облікового запису, або рядок unlimited. Позитивне значення не означає, що залишилися кредити API. |
data.reset |
integer | Секунди для хвилинного вікна облікового запису, а не для скидання місячної квоти. Вимкнені або необмежені хвилинні бюджети можуть зберігати номінальне значення 60 секунд; це не гарантує доступ після очікування. |
data.plan |
string | Поточна мітка плану. Читабельна назва плану надається окремо в data.quota.plan_name. |
data.quota.enabled |
boolean | Чи ввімкнено глобальний та плановий/кредитний доступ до API. Це не вказує на залишкову потужність і не замінює перемикач API користувача. |
data.quota.user_api_status |
boolean | Чи користувач увімкнув перемикач User API. Операції вимагають цього перемикача, а також увімкненого доступу та доступної потужності. |
data.quota.plan_name |
string | Зручна назва поточного плану. |
data.quota.period |
string | Період використання календарного місяця у форматі YYYY-MM, з використанням часового поясу застосунку; не обов’язково період виставлення рахунку за підписку. |
data.quota.base_limit |
integer | Базова місячна норма плану. Значення -1 означає безліміт. |
data.quota.extra_requests |
integer | Додатковий місячний ліміт надано для поточного періоду використання; окремо від придбаних кредитів. |
data.quota.monthly_limit |
integer | Базова норма плюс додаткові запити поточного періоду. Значення -1 означає безліміт. Придбані кредити не включені. |
data.quota.monthly_remaining |
integer|null | Залишок обмеженого місячного ліміту, або null, коли місячна квота безлімітна. Null не слід трактувати як нуль. |
data.quota.used |
integer | Успішні, враховані операції API у поточному періоді використання, включаючи операції, що використовують кредити. Перевірки статусу не збільшують це значення. |
data.quota.purchased_credits |
integer | Поточний баланс кредитів, включаючи бонусні кредити активного плану. Бонусні кредити не повинні додаватися до цього балансу вдруге. |
data.quota.bonus_credits |
integer | Активна частина бонусу плану у балансі кредитів; розподіл purchased_credits, а не додаткова місткість. |
data.quota.direct_purchased_credits |
integer | Баланс кредитів без урахування активної частини бонусу плану. Це значення плюс bonus_credits дорівнює purchased_credits. |
data.quota.remaining |
integer|null | Щомісячна залишкова норма плюс поточний баланс кредиту, без подвійного підрахунку бонусів. Null означає необмежену щомісячну квоту. Індивідуальні дозволи функцій та інші обмеження запитів залишаються в силі. |
data.quota.unlimited |
boolean | Чи є місячна квота безлімітною. Це не робить безлімітним бюджет хвилин облікового запису або інші обмеження функцій. |
data.quota.usage_percent |
integer | Сумісний з панеллю інструментів округлений відсоток від 0 до 100: використано поділено на використано плюс залишок, помножено на 100. Включає доступну кредитну потужність, тому поповнення може знизити відсоток. Це 0 для необмеженої квоти або пула нульового розміру; це не відсоток обмеження швидкості за хвилину і не рішення про доступ. |
data.quota.reset_at |
string | Мітка часу ISO-8601 з часовим зміщенням для наступного скидання квоти календарного місяця. Це не дата закінчення підписки, і щомісячне скидання не поповнює придбані кредити. |
status |
string | Буквальний успіх для цього кінцевого пункту статусу. Інші успішні кінцеві пункти поштових скриньок використовують булеве true. |
data.monthly_limit |
integer | Сумісний псевдонім відповідного поля data.quota; не додавайте його знову при розрахунку балансів. |
data.monthly_remaining |
integer|null | Сумісний псевдонім відповідного поля data.quota; не додавайте його знову при розрахунку балансів. |
data.purchased_credits |
integer | Сумісний псевдонім відповідного поля data.quota; не додавайте його знову при розрахунку балансів. |
Веб-гукальники пошти (реальний часовий пуш)
Замість постійного запиту REST-API (GET /messages) для перевірки надходження пошти, налаштуйте вебхуки, щоб вони відправляли нові повідомлення на ваш сервер або автоматизовану робочу процедуру в реальному часі.
Підтримувані події вебхуків
Кожен вебгук може підписуватися на один або кілька типи подій. Ваш кінцевий пункт отримує повідомлення про подію, коли одна з цих тригерів спрацьовує.
Відправляється в режимі реального часу, коли нове повідомлення надходить у вибрану поштову скриньку.
Відправляється, коли тимчасова поштову скриньку закінчується термін дії і обробка вебхука призупиняється.
Відправляється, коли прострочена поштову скриньку знову стає активною згідно правил плану.
Відправлено безпосередньо перед видаленням вебхука та його поштової скриньки.
Запити заголовків та перевірка підпису HMAC
Кожна доставка вебгука містить спеціальні заголовки безпеки. Використовуйте заголовок X-TempMailg-Signature, щоб перевірити, що надійшли запити були справді відправлені TempMailg і не були змінені.
| Назва заголовку | Приклад значення | Опис |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Стандартний ідентифікатор для робітника доставки вебхуків. |
X-TempMailg-Event |
email.received | Тип події, яка ініціювала цю доставку. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | Унікальний UUID, призначений цьому спробі доставки. |
X-TempMailg-Timestamp |
1725192000 | Мітка часу Unix epoch, що вказує, коли був ініційований запит. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | Підпис HMAC-SHA256, обчислений з {timestamp}.{raw_body} за допомогою вашого секрету. |
X-TempMailg-Test |
false | Правда, коли відправлено функцією "Send Test Ping" у вашій панелі керування. |
Підпис обчислюється за допомогою HMAC з SHA256 над рядком:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Приклад вмісту події (email.received)
Надійшло як application/json у тілі запиту HTTP POST.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:18:06+00:00",
"test": false,
"mailbox": {
"id": 1024,
"email": "developer@v1.tempmailg.com"
},
"data": {
"message_id": "7a8b9c0d1e2f",
"subject": "Your Verification Code: 948201",
"from": "auth@service.com",
"to": "developer@v1.tempmailg.com",
"date": "2026-11-19T02:18:06+00:00",
"attachments_count": 0,
"text_preview": "Hello, your one-time verification code is 948201. It will expire in 10 minutes.",
"email_url": "https://tempmailg.com/mailbox/1024?message=7a8b9c0d1e2f",
"inbox_url": "https://tempmailg.com/mailbox/1024"
}
}
Приклади реалізації отримувача
Виберіть свою мову, щоб дізнатися, як безпечно отримувати вебхуки та перевіряти підписи HMAC.
const express = require('express');
const crypto = require('crypto');
const app = express();
const WEBHOOK_SECRET = 'your_webhook_signing_secret';
// Capture raw body buffer for HMAC-SHA256 signature verification
app.use(express.json({
verify: (req, res, buf) => {
req.rawBody = buf.toString('utf8');
}
}));
app.post('/webhook', (req, res) => {
const timestamp = req.headers['x-tempmailg-timestamp'];
const signatureHeader = req.headers['x-tempmailg-signature'] || '';
// Calculate HMAC-SHA256 signature
const expectedSignature = 'sha256=' + crypto
.createHmac('sha256', WEBHOOK_SECRET)
.update(`${timestamp}.${req.rawBody}`)
.digest('hex');
// Verify signature
if (signatureHeader !== expectedSignature) {
return res.status(401).json({ error: 'Invalid webhook signature' });
}
const { event, mailbox, data } = req.body;
console.log(`[Event: ${event}] Mailbox: ${mailbox.email}`);
if (event === 'email.received') {
console.log(`From: ${data.from}`);
console.log(`Subject: ${data.subject}`);
console.log(`Preview: ${data.text_preview}`);
}
// Acknowledge receipt with HTTP 200
res.status(200).json({ received: true });
});
app.listen(3000, () => console.log('Webhook receiver running on port 3000'));
from flask import Flask, request, jsonify
import hmac
import hashlib
app = Flask(__name__)
WEBHOOK_SECRET = b"your_webhook_signing_secret"
@app.route("/webhook", methods=["POST"])
def handle_webhook():
timestamp = request.headers.get("X-TempMailg-Timestamp", "")
signature_header = request.headers.get("X-TempMailg-Signature", "")
# Calculate expected HMAC-SHA256 signature
raw_body = request.get_data()
signed_payload = f"{timestamp}.".encode("utf-8") + raw_body
expected_signature = "sha256=" + hmac.new(
WEBHOOK_SECRET, signed_payload, hashlib.sha256
).hexdigest()
# Verify signature securely
if not hmac.compare_digest(signature_header, expected_signature):
return jsonify({"error": "Invalid signature"}), 401
payload = request.get_json()
event = payload.get("event")
mailbox = payload.get("mailbox", {}).get("email")
data = payload.get("data", {})
print(f"[{event}] Mailbox: {mailbox}")
if event == "email.received":
print(f"From: {data.get('from')}")
print(f"Subject: {data.get('subject')}")
print(f"Preview: {data.get('text_preview')}")
# Return 200 OK to acknowledge receipt
return jsonify({"received": True}), 200
if __name__ == "__main__":
app.run(port=5000)
<?php
$secret = 'your_webhook_signing_secret';
$rawBody = file_get_contents('php://input');
$timestamp = $_SERVER['HTTP_X_TEMPMAILG_TIMESTAMP'] ?? '';
$receivedSignature = $_SERVER['HTTP_X_TEMPMAILG_SIGNATURE'] ?? '';
// Calculate HMAC-SHA256 signature
$expectedSignature = 'sha256=' . hash_hmac('sha256', $timestamp . '.' . $rawBody, $secret);
// Verify signature
if (!hash_equals($expectedSignature, $receivedSignature)) {
http_response_code(401);
echo json_encode(['error' => 'Invalid signature']);
exit;
}
$payload = json_decode($rawBody, true);
$event = $payload['event'] ?? '';
$mailbox = $payload['mailbox']['email'] ?? '';
$data = $payload['data'] ?? [];
if ($event === 'email.received') {
$sender = $data['from'] ?? '';
$subject = $data['subject'] ?? '';
$preview = $data['text_preview'] ?? '';
// Process new incoming email...
}
// Acknowledge receipt
http_response_code(200);
echo json_encode(['received' => true]);
Підтримувані платформи та інтеграції автоматизації
Вебхуки TempMailg працюють одразу з стандартними HTTPS-кінцевими точками та провідними платформами без коду/автоматизації:
Спільні помилки та виправлення
Це найпоширеніші коди відповідей, які ви можете бачити під час інтеграції користувача API.
Недійсний, відсутній або відкликаний токен Bearer.
Власність, дозволи функцій, доступ до домену або розмір вкладення завадили виконанню операції. Перевірте код відповіді та повідомлення.
Ресурс не знайдено на дозволеному хості або не належить користувачеві.
Ключ операції був повторно використаний з іншими деталями, інша операція очікує, або безпека поштової скриньки змінилася. Перевірте код перед повторною спробою.
Скринька пошти закінчила термін дії або є неактивною.
Недійсні параметри, заборонений термін дії, недоступна місткість псевдоніму, неправильне налаштування PIN-коду або відсутній/недійсний Idempotency-Key завадили виконанню операції.
Захищена поштову скриньку потрібен дійсний токен X-Mailbox-Unlock з відповідною областю. Використайте action і target_id з відповіді для видалення. Потрібно вирішити вимоги блокування або відновлення перед повторною спробою.
Ліміт запитів, вимкнений план, вичерпана квота або час очікування завадили виконанню операції. Перевірте причину та заголовки доступного бюджету. Retry-After є необов’язковим.
Сервер не зміг завершити операцію. Для захищеного створення або видалення збережіть той самий запит і Idempotency-Key під час повторної спроби.
Зберігання захисту або координація не могли бути підтверджені. Спробуйте ще раз після вказаної затримки. Ця відповідь не є невдалою оплатою.
Швидкий список перевірки
- 401 Unauthorized - Токен Bearer відсутній, неправильний, скасований або скопійований неправильно.
- 403 Forbidden - Поточний план не має права доступу до користувача API зараз.
- 404 Not Found - Ресурс не знайдено або недійсний параметр
- 410 Gone / Expired - Поштова скринька закінчила термін дії або більше не активна.
- 429 Rate Limited - Перевірте причину відповіді та заголовки бюджету. Retry-After застосовується лише до обмежень за часом; вичерпані кредити або вимкнений доступ можуть вимагати зміни облікового запису.
Рекомендований наступний крок
Якщо ви увійшли до системи, спочатку відкрийте API Management та підтвердіть свій ключ, ліміт квоти, план доступу та точну базову URL-адресу користувача API перед налагодженням вашого зовнішнього додатка.