Szybka lista kontroli konfiguracji
- Otwórz stronę API Management na swoim pulpicie i utwórz swój osobisty klucz API.
- Skopiuj dokładny adres URL bazy API użytkownika wyświetlany tam, na przykład https://v1.tempmailg.com/api.
- Wyślij każde żądanie do tego hosta API z Authorization: Bearer YOUR_USER_API_KEY i Accept: application/json.
- Śledź swój miesięczny limit żądań z tej samej strony pulpitu oraz z nagłówków limitu, gdy są dostępne w odpowiedziach API użytkownika. Tylko udane żądania 2xx liczą się w ramach limitu.
Dostęp do klucza API
Zaloguj się, aby utworzyć swój osobisty klucz API i wyświetlić szczegóły limitu na żywo.
Przepływ uwierzytelniania
- Wygeneruj swój osobisty klucz API ze strony Zarządzania API w pulpitu nawigacyjnym.
- Wyślij klucz jako token Bearer w każdym żądaniu.
- Użyj dedykowanego adresu URL bazowego API Użytkownika wyświetlanego na stronie Zarządzania API.
- Wygeneruj nowy klucz w każdej chwili, gdy chcesz unieważnić stary i zacząć używać nowego klucza natychmiast.
Wymagane nagłówki
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Nagłówki limitu & przydziału
Nagłówki limitu zapytań opisują wskazany budżet żądań. Nagłówki przydziału są dołączane, gdy dostępne są informacje o przydziale; odrzucenia limitu minutowego nie obliczają pełnego miesięcznego przydziału.
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— Maksymalna liczba żądań dozwolona na minutę (RPM) w ramach Twojego planu.X-RateLimit-Remaining— Pozostałe żądania RPM w bieżącym oknie minutowym.X-RateLimit-Reset— Znacznik czasu Unix, kiedy resetuje się bieżące okno limitu szybkości na minutę.X-Quota-Limit— Całkowita miesięczna i zakupiona pojemność kredytowa Twojego konta.X-Quota-Remaining— Pozostała dostępna liczba żądań API w bieżącym miesiącu.X-Quota-Used— Łączna liczba żądań API zużytych w bieżącym okresie rozliczeniowym.X-Quota-Reset— Znacznik czasu ISO-8601, kiedy resetuje się Twój miesięczny limit.X-RateLimit-Scope— Budżet opisany w nagłówkach: account, ip, status_endpoint lub mailbox.X-Mailbox-RateLimit-*— Oddzielny budżet tworzenia/aktualizacji skrzynki pocztowej. Pomyślne odpowiedzi skrzynki pocztowej utrzymują RPM konta w X-RateLimit-*; odrzucenie tylko skrzynki używa zakresu skrzynki i własnego okna ponownej próby.Retry-After— Sekundy, aż ponowna próba w określonym czasie będzie odpowiednia. Wyłączony plan lub wyczerpany limit może wymagać zmiany konta, więc ten nagłówek nie zawsze jest obecny.503 protection_unavailable— Przechowywanie lub koordynacja ochrony API jest tymczasowo niedostępna. Spróbuj ponownie później; nie jest to błąd płatności ani obciążenie kredytowe.
Zarządzanie skrzynką pocztową
Pobierz dozwolone domeny, utwórz lub zmień skrzynki pocztowe, wybierz dozwolone okresy ważności i usuń posiadane adresy.
Lista dozwolonych domen
Wyświetl dostępne domeny do tworzenia tymczasowych e‑maili. Filtruj według typu, aby zobaczyć tylko darmowe, premium lub niestandardowe domeny obsługiwane w ramach Twojego planu subskrypcyjnego.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
type
|
query | string | opcjonalny |
Filtr poziomu domeny. Pominięcie używa wszystkich, gdy dostęp do domen premium jest włączony, w przeciwnym razie darmowych. Rozpoznane wartości: free, basic, pro, premium, custom, ultimate, all
Domyślnie:
Zależny od konta
|
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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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
}
]
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.requested_type |
string | Zastosowano filtr domeny. |
data.plan |
string | Aktualny znacznik planu. |
data.plan_name |
string | Czytelna nazwa bieżącego planu. |
data.allowed_types |
array<string> | Filtry domen dostępne dla tego konta. Rozpoznany filtr może nadal być zabroniony w Twoim planie. |
data.domains |
array | Dostępne domeny po filtrowaniu; pusta tablica jest prawidłowa. |
data.domains[].domain |
string | Wybieralna nazwa domeny. |
data.domains[].type |
string | Etykieta poziomu domeny odczytywalnej. |
data.domains[].custom |
boolean | Czy jest to niestandardowa domena. |
Utwórz tymczasową skrzynkę pocztową
Utwórz własną tymczasową skrzynkę pocztową. Pomiń nazwę użytkownika i domenę, aby wygenerować losowo, lub podaj dozwoloną niestandardową nazwę użytkownika i dozwoloną domenę. Parametr provider może wybrać generowanie aliasu Gmail lub Outlook.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
username
|
body | string | opcjonalny |
Opcjonalna niestandardowa nazwa użytkownika: od 2 do 64 znaków ASCII, litery, cyfry, kropki, podkreślenia lub myślniki. Wymaga uprawnienia planu; akceptowane jest również custom_username.
Domyślnie:
Wygenerowane losowo
|
domain
|
body | string | opcjonalny |
Jedna z dozwolonych domen zwróconych przez GET /domains. Pominięcie wybiera losową dozwoloną domenę.
Domyślnie:
Losowo dozwolona domena
|
lifetime
|
body | string | opcjonalny |
dozwolone wartości:
10m — 10 minut
1h — 1 Godzina
2h — 2 godziny
1d — 1 dzień
1w — 1 Tydzień
1m — 30 dni
3m — 90 dni
6m — 180 dni
1y — 365 dni
unlimited — Nielimitowane
Domyślnie:
Domyślny okres życia planu
|
provider
|
body | string | opcjonalny |
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
Domyślnie:
standard
|
pin_enabled
|
body | boolean | opcjonalny |
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie:
false
|
pin
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
|
pin_confirmation
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
|
Idempotency-Key
|
header | string | opcjonalny |
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
|
username (niestandardowa nazwa użytkownika, jeśli jest dozwolona w planie), domain (dozwolona domena, np. example.com), lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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:17:52+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:17:52+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.id |
integer | Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki. |
data.pin_protected |
boolean | Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany. |
data.email |
string | Wygenerowano pełny adres skrzynki pocztowej. |
data.domain |
string | Domena generowanej skrzynki pocztowej. |
data.provider |
string | Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias. |
data.expire_at |
string|null | Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej. |
data.expires_in_seconds |
number|null | Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero. |
data.mailbox_state |
string | Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny. |
data.receiving_enabled |
boolean | Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości? |
data.message_count |
integer | Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.unread_message_count |
integer | Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.last_message_received_at |
string|null | Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny. |
data.message_count_synced_at |
string|null | Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją. |
data.created_at |
string|null | Czas utworzenia skrzynki pocztowej w formacie ISO-8601. |
data.email_token |
string | Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN. |
data.pin_grant |
object | Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je. |
data.pin_grant.mailbox_id |
integer | Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt. |
data.pin_grant.unlock_token |
string | Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia. |
data.pin_grant.scope |
string | Zakres odczytu dla warunkowego przyznania tworzenia. |
data.pin_grant.idle_timeout_seconds |
integer | Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund. |
data.pin_grant.expires_at |
string | Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej. |
Aktualizuj / Zmień skrzynkę pocztową
Utwórz lub wybierz skrzynkę pocztową pod nową nazwą użytkownika i domeną po zweryfikowaniu własności bieżącej skrzynki. To nie zmienia nazwy starej skrzynki ani nie modyfikuje jej okresu ważności w miejscu. Gdy docelowy adres różni się, stara skrzynka pozostaje w historii i może być wstrzymana przez limity aktywnych skrzynek. Ponowne użycie własnego aktywnego docelowego adresu przywraca żądany okres ważności lub domyślny plan.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
email
|
path | string | wymagane |
Aktualny pełny adres e-mail posiadanej skrzynki pocztowej do przełączenia. URL-encode każdy segment ścieżki; zakoduj znak plus jako %2B.
|
username
|
path | string | wymagane |
Nowa żądana nazwa użytkownika: od 2 do 64 znaków alfanumerycznych; podlega uprawnieniom do niestandardowych nazw użytkowników.
|
domain
|
path | string | wymagane |
Nowa dozwolona nazwa domeny.
|
lifetime
|
body | string | opcjonalny |
dozwolone wartości:
10m — 10 minut
1h — 1 Godzina
2h — 2 godziny
1d — 1 dzień
1w — 1 Tydzień
1m — 30 dni
3m — 90 dni
6m — 180 dni
1y — 365 dni
unlimited — Nielimitowane
Domyślnie:
Domyślny okres życia planu
|
pin_enabled
|
body | boolean | opcjonalny |
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie:
false
|
pin
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
|
pin_confirmation
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
|
Idempotency-Key
|
header | string | opcjonalny |
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
|
X-Mailbox-Unlock
|
header | string | opcjonalny |
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie Bearer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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:27:52+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:17:52+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.id |
integer | Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki. |
data.pin_protected |
boolean | Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany. |
data.email |
string | Wygenerowano pełny adres skrzynki pocztowej. |
data.domain |
string | Domena generowanej skrzynki pocztowej. |
data.provider |
string | Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias. |
data.expire_at |
string|null | Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej. |
data.expires_in_seconds |
number|null | Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero. |
data.mailbox_state |
string | Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny. |
data.receiving_enabled |
boolean | Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości? |
data.message_count |
integer | Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.unread_message_count |
integer | Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.last_message_received_at |
string|null | Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny. |
data.message_count_synced_at |
string|null | Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją. |
data.created_at |
string|null | Czas utworzenia skrzynki pocztowej w formacie ISO-8601. |
data.email_token |
string | Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN. |
data.pin_grant |
object | Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je. |
data.pin_grant.mailbox_id |
integer | Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt. |
data.pin_grant.unlock_token |
string | Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia. |
data.pin_grant.scope |
string | Zakres odczytu dla warunkowego przyznania tworzenia. |
data.pin_grant.idle_timeout_seconds |
integer | Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund. |
data.pin_grant.expires_at |
string | Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej. |
Usuń skrzynkę pocztową
Usuń posiadaną skrzynkę pocztową i wywołaj jej czyszczenie wiadomości i plików. Zachowane rekordy skrzynki mogą być wewnętrznie miękko usunięte; adres nie jest już dostępny przez API.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
email
|
path | string | wymagane |
Pełny adres e‑mail skrzynki pocztowej, którą należy usunąć. Zakoduj adres w formacie URL; znak plusa zakoduj jako %2B.
|
X-Mailbox-Unlock
|
header | string | opcjonalny |
Nagłówek, tylko chronione skrzynki pocztowe: użyj jednorazowego tokenu unlock_token do usuwania. Najpierw wyślij POST pin, scope=delete i action/target_id zwrócone w odpowiedzi 423 na URL odblokowujący PIN. Token odczytu nie może usuwać. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | opcjonalny |
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
|
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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
message |
string | Wynik usunięcia. Brakujący zasób zwraca HTTP 404. |
Aliasy Gmail i Outlook
Generuj skrzynki aliasowe Gmail i Outlook/Hotmail o wysokiej reputacji.
Utwórz alias Gmail
Utwórz nową tymczasową skrzynkę aliasu Gmail, będącą własnością uwierzytelnionego użytkownika.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
mode
|
body | string | opcjonalny |
Tryb generowania: auto, dot, plus lub plus_dot. Akceptuje także gmail_alias_mode. Jeśli wybór stylu nie jest dozwolony, używany jest auto.
Domyślnie:
auto
|
username
|
body | string | opcjonalny |
Opcjonalny niestandardowy przyrostek aliasu: od 2 do 32 znaków ASCII (litery lub cyfry), znormalizowany do małych liter; podlega uprawnieniom funkcji. Akceptuje także custom_username lub alias_username.
Domyślnie:
Automatycznie wygenerowane
|
domain
|
body | string | opcjonalny |
Użyj losowego, gmail.com lub googlemail.com; alias_domain jest również akceptowany. Pominięcie lub brak uprawnienia do wyboru domeny używa losowego.
Domyślnie:
random
|
lifetime
|
body | string | opcjonalny |
dozwolone wartości:
10m — 10 minut
1h — 1 Godzina
2h — 2 godziny
1d — 1 dzień
1w — 1 Tydzień
1m — 30 dni
3m — 90 dni
6m — 180 dni
1y — 365 dni
unlimited — Nielimitowane
Domyślnie:
Domyślny okres życia planu
|
pin_enabled
|
body | boolean | opcjonalny |
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie:
false
|
pin
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
|
pin_confirmation
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
|
Idempotency-Key
|
header | string | opcjonalny |
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
|
mode (auto, dot, plus, plus_dot), username (niestandardowa nazwa aliasu użytkownika), domain (np. gmail.com, googlemail.com), lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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:17:52+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:17:52+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.id |
integer | Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki. |
data.pin_protected |
boolean | Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany. |
data.email |
string | Wygenerowano pełny adres skrzynki pocztowej. |
data.domain |
string | Domena generowanej skrzynki pocztowej. |
data.provider |
string | Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias. |
data.expire_at |
string|null | Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej. |
data.expires_in_seconds |
number|null | Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero. |
data.mailbox_state |
string | Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny. |
data.receiving_enabled |
boolean | Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości? |
data.message_count |
integer | Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.unread_message_count |
integer | Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.last_message_received_at |
string|null | Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny. |
data.message_count_synced_at |
string|null | Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją. |
data.created_at |
string|null | Czas utworzenia skrzynki pocztowej w formacie ISO-8601. |
data.email_token |
string | Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN. |
data.pin_grant |
object | Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je. |
data.pin_grant.mailbox_id |
integer | Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt. |
data.pin_grant.unlock_token |
string | Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia. |
data.pin_grant.scope |
string | Zakres odczytu dla warunkowego przyznania tworzenia. |
data.pin_grant.idle_timeout_seconds |
integer | Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund. |
data.pin_grant.expires_at |
string | Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej. |
Domeny aliasów Outlook
Pobierz aktywne domeny aliasów Outlook / Hotmail dostępne do generowania skrzynki pocztowej.
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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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
}
]
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.domains |
array | Aktywne domeny Outlook/Hotmail; pusty array jest prawidłowy. |
data.domains[].domain |
string | Dostępna nazwa domeny. |
data.domains[].type |
string | Czytelna etykieta dostawcy. |
data.domains[].selectable |
boolean | Czy Twoje konto może wyraźnie wybrać tę domenę. |
data.domains[].locked |
boolean | Czy wyraźny wybór domeny jest zablokowany dla Twojego konta. |
data.domains[].disabled_reason |
string|null | Powód, dla którego wybór domeny jest zablokowany, lub null, gdy jest możliwy do wyboru. |
Utwórz alias Outlook
Utwórz nową tymczasową skrzynkę pocztową aliasu Outlook / Hotmail należącą do uwierzytelnionego użytkownika.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
domain
|
body | string | opcjonalny |
Użyj losowego lub domeny z GET /outlook-alias/domains; outlook_alias_domain jest również akceptowane. Bez uprawnienia wyboru używany jest losowy.
Domyślnie:
Losowa dostępna domena
|
username
|
body | string | opcjonalny |
Opcjonalny niestandardowy przyrostek aliasu: od 2 do 32 znaków ASCII (litery lub cyfry), znormalizowany do małych liter; podlega uprawnieniom funkcji. Akceptuje także custom_username lub alias_username.
Domyślnie:
Automatycznie wygenerowane
|
lifetime
|
body | string | opcjonalny |
dozwolone wartości:
10m — 10 minut
1h — 1 Godzina
2h — 2 godziny
1d — 1 dzień
1w — 1 Tydzień
1m — 30 dni
3m — 90 dni
6m — 180 dni
1y — 365 dni
unlimited — Nielimitowane
Domyślnie:
Domyślny okres życia planu
|
pin_enabled
|
body | boolean | opcjonalny |
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie:
false
|
pin
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
|
pin_confirmation
|
body | string | opcjonalny |
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
|
Idempotency-Key
|
header | string | opcjonalny |
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
|
domain (np. outlook.com, hotmail.com), username (niestandardowa nazwa aliasu użytkownika), lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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:17:52+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:17:52+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.id |
integer | Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki. |
data.pin_protected |
boolean | Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany. |
data.email |
string | Wygenerowano pełny adres skrzynki pocztowej. |
data.domain |
string | Domena generowanej skrzynki pocztowej. |
data.provider |
string | Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias. |
data.expire_at |
string|null | Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej. |
data.expires_in_seconds |
number|null | Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero. |
data.mailbox_state |
string | Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny. |
data.receiving_enabled |
boolean | Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości? |
data.message_count |
integer | Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.unread_message_count |
integer | Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
data.last_message_received_at |
string|null | Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny. |
data.message_count_synced_at |
string|null | Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją. |
data.created_at |
string|null | Czas utworzenia skrzynki pocztowej w formacie ISO-8601. |
data.email_token |
string | Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN. |
data.pin_grant |
object | Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je. |
data.pin_grant.mailbox_id |
integer | Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt. |
data.pin_grant.unlock_token |
string | Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia. |
data.pin_grant.scope |
string | Zakres odczytu dla warunkowego przyznania tworzenia. |
data.pin_grant.idle_timeout_seconds |
integer | Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund. |
data.pin_grant.expires_at |
string | Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej. |
Wiadomości i załączniki
Pobierz przychodzące skrzynki odbiorcze, odczytaj pełne wiadomości HTML/tekstowe i strumieniuj załączniki.
Wyświetl wiadomości skrzynki pocztowej
Pobierz dostępne podsumowania wiadomości i metadane skrzynki pocztowej. Standardowe skany skrzynki odbiorczej zwracają ostatnią partię do 25 wiadomości; nie jest to strona z pełną historią. Użyj GET /messages/{messageId} aby uzyskać pełne treści i załączniki.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
email
|
query | string | wymagane |
Pełny adres e‑mail posiadanej skrzynki pocztowej, z której odczytywać wiadomości. Zakoduj wartość zapytania w formacie URL; zakoduj znak plus jako %2B.
|
X-Mailbox-Unlock
|
header | string | opcjonalny |
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie 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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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:17:52",
"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:17:52+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:17:52+00:00",
"message_count_synced_at": "2026-11-19T02:17:52+00:00"
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
mailbox |
string | Adres skrzynki pocztowej, z której żądano wiadomości. |
email_token |
string | Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej; nadal wymagana jest standardowa autoryzacja. |
mailbox_provider |
string | Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias. |
messages |
array | Podsumowania wiadomości. Pusta skrzynka odbiorcza zwraca pustą tablicę; pobierz pojedynczą wiadomość, aby uzyskać jej treść i załączniki. |
expire_at |
string|null | Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej. |
expires_in_seconds |
number|null | Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero. |
mailbox_state |
string | Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny. |
receiving_enabled |
boolean | Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości? |
message_count |
integer | Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
unread_message_count |
integer | Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej. |
last_message_received_at |
string|null | Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny. |
message_count_synced_at |
string|null | Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją. |
mailbox_limit.limit |
integer | Aktywny limit skrzynek pocztowych dla tego dostawcy; -1 oznacza nieograniczony. |
mailbox_limit.limit_label |
string | Etykieta wyświetlana dla limitu skrzynki pocztowej. |
mailbox_limit.active_count |
integer | Liczba aktywnych skrzynek pocztowych dla tego dostawcy. |
mailbox_limit.paused_count |
integer | Liczba wstrzymanych skrzynek pocztowych dla tego dostawcy. |
mailbox_limit.paused_mailboxes |
array<string> | Adresy wstrzymane z powodu limitu skrzynki pocztowej. |
mailbox_limit.remaining |
integer | Pozostałe aktywne sloty skrzynek pocztowych; -1 oznacza nieograniczone. To nie jest limit zapytań API. |
mailbox_limit.remaining_label |
string | Wyświetl etykietę dla pozostałych miejsc w skrzynce pocztowej. |
mailbox_limit.reached |
boolean | Czy osiągnięto limit aktywnych skrzynek pocztowych. |
mailbox_limit.blocked |
boolean | Czy limit aktywnej skrzynki pocztowej wynosi zero. |
mailbox_limit.provider |
string|null | Dostawca, którego dotyczy limit skrzynki pocztowej. |
messages[].id |
string | Nieprzezroczysty identyfikator wiadomości używany przez endpointy pojedynczej wiadomości, usuwania i załącznika. |
messages[].is_seen |
boolean | Czy wiadomość jest oznaczona jako przeczytana. |
messages[].subject |
string | Temat wiadomości. |
messages[].from |
string | Wyświetlana nazwa nadawcy lub adres. |
messages[].from_email |
string | Adres e‑mail nadawcy. |
messages[].receivedAt |
string | Czas otrzymania w strefie czasowej aplikacji, sformatowany jako YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Wykryto jednorazowy kod, gdy jest dostępny i dozwolony; w przeciwnym razie null. |
messages[].otp_locked |
boolean | Czy wykryty jednorazowy kod jest ukryty przez uprawnienia funkcji. |
messages[].verification_link |
string|null | Wykryto adres URL weryfikacji, gdy jest dostępny i dozwolony; w przeciwnym razie null. |
messages[].verification_link_locked |
boolean | Czy wykryty link weryfikacyjny jest ukryty przez uprawnienia funkcji. |
messages[].from_name |
string|null | Pole podsumowania Outlook: nazwa oryginalnego nadawcy. Brak w podsumowaniach Standard i Gmail. |
messages[].snippet |
string|null | Pole podsumowania Outlook: krótki podgląd wiadomości. |
messages[].received_at |
string|null | Pole podsumowania Outlook: otrzymany czas w formacie ISO-8601, gdy jest znany. |
messages[].has_attachments |
boolean | Pole podsumowania Outlook: czy istnieją metadane załącznika. Dostępność pobierania jest sprawdzana osobno. |
Pobierz pojedynczą wiadomość
Pobierz własną wiadomość za pomocą jej nieprzezroczystego identyfikatora wiadomości. Zwraca formaty treści i metadane załączników. Pola treści zależą od formatu wiadomości; Outlook dodaje poniżej wymienione pola specyficzne dla dostawcy.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
messageId
|
path | string | wymagane |
Unikalny identyfikator wiadomości zwracany w liście wiadomości.
|
X-Mailbox-Unlock
|
header | string | opcjonalny |
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie 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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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:17:52",
"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"
}
]
}
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
data.id |
string | Nieprzezroczysty identyfikator wiadomości. |
data.is_seen |
boolean | Stan odczytu wiadomości. Odczyt może oznaczyć ją jako przeczytaną; dane w pamięci podręcznej mogą odzwierciedlać wcześniejszy stan. |
data.subject |
string | Temat wiadomości. |
data.from |
string | Wyświetlana nazwa nadawcy lub adres. |
data.from_email |
string | Adres e‑mail nadawcy. |
data.to |
string | Adres skrzynki odbiorczej odbiorcy. |
data.mailbox_provider |
string | Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias. |
data.receivedAt |
string | Czas otrzymania w strefie czasowej aplikacji, sformatowany jako YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Czy wiadomość ma ciało w formacie HTML. |
data.html_content |
string | Treść HTML, gdy jest obecna. Standardowe wiadomości bez HTML mogą pominąć to pole. Traktuj zawartość wiadomości jako nieufną. |
data.text_content |
string | Treść tekstu, gdy jest obecna; Standardowe wiadomości mogą zawierać tekst z escapowanymi znakami w elemencie pre lub pominąć to pole. |
data.content |
string | Preferowana treść do wyświetlenia, zazwyczaj HTML, gdy dostępna. |
data.attachments |
array | Metadane załącznika lub pustą tablicę. Pobieranie wymaga normalnego uwierzytelnienia i odpowiedniej autoryzacji kodem PIN. |
data.attachments[].name |
string | Nazwa pliku do zakodowania w URL jako pojedynczy segment ścieżki podczas pobierania. |
data.attachments[].size |
integer | Rozmiar załącznika w bajtach. |
data.attachments[].url |
string | Adres URL pobierania API uwierzytelnionego użytkownika został dodany do załączników z nazwą pliku. URL nie gwarantuje, że lokalny plik jest dostępny. |
data.attachments[].extension |
string | Standardowe/pole metadanych Gmail: rozszerzenie pliku, jeśli podano. |
data.attachments[].id |
string | Pole metadanych Outlook: identyfikator załącznika dostawcy. |
data.attachments[].content_type |
string | Pole metadanych Outlook: typ zawartości MIME. |
data.from_name |
string|null | Pole szczegółowe Outlook: oryginalna nazwa nadawcy. |
data.to_email |
string|null | Pole szczegółowe Outlook: oryginalny adres odbiorcy. |
data.received_at |
string|null | Pole szczegółowe Outlook: otrzymany czas w formacie ISO-8601. |
data.has_html |
boolean | Pole szczegółowe Outlook: czy istnieje treść HTML. |
Usuń wiadomość
Usuń jedną wiadomość należącą do użytkownika.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
messageId
|
path | string | wymagane |
Unikalny ciąg identyfikatora wiadomości do trwałego usunięcia.
|
X-Mailbox-Unlock
|
header | string | opcjonalny |
Nagłówek, tylko chronione skrzynki pocztowe: użyj jednorazowego tokenu unlock_token do usuwania. Najpierw wyślij POST pin, scope=delete i action/target_id zwrócone w odpowiedzi 423 na URL odblokowujący PIN. Token odczytu nie może usuwać. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | opcjonalny |
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
|
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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Pole | Typ | Opis |
|---|---|---|
status |
boolean | Czy operacja zakończyła się sukcesem? |
message |
string | Wynik usunięcia. Brakujący zasób zwraca HTTP 404. |
Pobierz załącznik
Pobierz załącznik z wiadomości należącej do użytkownika.
| Parametr | Lokalizacja | Typ | Status | Opis |
|---|---|---|---|---|
messageId
|
path | string | wymagane |
Identyfikator wiadomości zawierającej plik.
|
filename
|
path | string | wymagane |
Nazwa pliku i rozszerzenie załącznika do pobrania.
|
X-Mailbox-Unlock
|
header | string | opcjonalny |
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie 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
| Pole | Typ | Opis |
|---|---|---|
Content-Disposition |
header | Udana odpowiedź pobiera żądaną nazwę pliku. |
body |
binary | Bajty pliku przy sukcesie, nie JSON. Błędy zwracają JSON z kodem statusu innym niż 2xx. |
Limity i kwoty
Monitoruj w czasie rzeczywistym budżety żądań, limity szybkości i limity kont bez zużywania kredytów.
Limit szybkości i limit przydziału
Sprawdź aktualny limit szybkości i status przydziału, nie zużywając żadnego użycia API. Ten punkt końcowy jest wolny od przydziału i nie odejmuje miesięcznych kredytów API (limit ochrony przed nadużyciami: 60 żądań/min).
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'
Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.
Przykładowa odpowiedź
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"
}
}
}
| Pole | Typ | Opis |
|---|---|---|
data.limit |
integer|string | Limit żądań na minutę konta. Ciąg unlimited oznacza nieograniczony budżet minutowy; jest to niezależne od miesięcznego limitu. |
data.remaining |
integer|string | Pozostałe sloty minutowego budżetu konta, lub ciąg "unlimited". Dodatnia wartość nie oznacza, że pozostały kredyty API. |
data.reset |
integer | Sekundy dla okna minutowego konta, a nie resetu miesięcznego przydziału. Wyłączone lub nieograniczone budżety minutowe mogą zachować nominalną wartość 60 sekund; nie gwarantuje to dostępu po oczekiwaniu. |
data.plan |
string | Aktualny znacznik planu. Czytelna nazwa planu jest podana osobno w data.quota.plan_name. |
data.quota.enabled |
boolean | Czy dostęp globalny oraz planowy/kredytowy do API jest włączony. To nie wskazuje pozostałej pojemności ani nie zastępuje przełącznika API użytkownika. |
data.quota.user_api_status |
boolean | Czy użytkownik włączył przełącznik API użytkownika. Operacje wymagają tego przełącznika, a także włączonego dostępu i dostępnej pojemności. |
data.quota.plan_name |
string | Czytelna nazwa bieżącego planu. |
data.quota.period |
string | Okres użytkowania w formacie miesiąca kalendarzowego YYYY-MM, z użyciem strefy czasowej aplikacji; niekoniecznie okres rozliczeniowy subskrypcji. |
data.quota.base_limit |
integer | Podstawowy miesięczny przydział planu. Wartość -1 oznacza nieograniczoną. |
data.quota.extra_requests |
integer | Dodatkowy miesięczny przydział przyznany na bieżący okres użytkowania; oddzielny od zakupionych kredytów. |
data.quota.monthly_limit |
integer | Podstawowy przydział plus dodatkowe żądania z bieżącego okresu. Wartość -1 oznacza nieograniczony. Zakupione kredyty nie są uwzględnione. |
data.quota.monthly_remaining |
integer|null | Pozostały skończony miesięczny przydział, lub null, gdy miesięczny przydział jest nieograniczony. Null nie powinien być interpretowany jako zero. |
data.quota.used |
integer | Udane, liczone operacje API w bieżącym okresie użytkowania, w tym operacje wykorzystujące kredyty. Kontrole statusu nie zwiększają tej wartości. |
data.quota.purchased_credits |
integer | Aktualny stan kredytów, w tym bonusowe kredyty z aktywnego planu. Bonusowe kredyty nie powinny być dodawane do tego stanu po raz drugi. |
data.quota.bonus_credits |
integer | Aktywna część bonusu planu w saldzie kredytów; rozbicie purchased_credits, a nie dodatkowa pojemność. |
data.quota.direct_purchased_credits |
integer | Saldo kredytów z wyłączeniem aktywnej części bonusu planu. Ta wartość plus bonus_credits równa się purchased_credits. |
data.quota.remaining |
integer|null | Miesięczny pozostały limit plus bieżące saldo kredytowe, bez podwójnego liczenia bonusów. Null oznacza nieograniczony miesięczny limit. Indywidualne uprawnienia funkcji i inne limity żądań nadal obowiązują. |
data.quota.unlimited |
boolean | Czy miesięczny limit jest nieograniczony. Nie powoduje to, że budżet minutowy konta lub inne limity funkcji są nieograniczone. |
data.quota.usage_percent |
integer | Kompatybilny z panelem kontrolnym, zaokrąglony procent od 0 do 100: użyte podzielone przez użyte plus pozostałe, pomnożone przez 100. Zawiera dostępny przydział kredytowy, więc doładowanie może obniżyć procent. Wynosi 0 dla nieograniczonego limitu lub puli o zerowym rozmiarze; nie jest to procent limitu na minutę ani decyzja o dostępie. |
data.quota.reset_at |
string | Znacznik czasu ISO-8601 z przesunięciem strefy czasowej dla następnego resetu limitu w kolejnym miesiącu kalendarzowym. To nie jest data wygaśnięcia subskrypcji, a miesięczny reset nie uzupełnia zakupionych kredytów. |
status |
string | Dosłowny sukces dla tego punktu końcowego statusu. Inne udane punkty końcowe skrzynek używają wartości logicznej true. |
data.monthly_limit |
integer | Alias zgodności odpowiadającego pola data.quota; nie dodawaj go ponownie przy obliczaniu sald. |
data.monthly_remaining |
integer|null | Alias zgodności odpowiadającego pola data.quota; nie dodawaj go ponownie przy obliczaniu sald. |
data.purchased_credits |
integer | Alias zgodności odpowiadającego pola data.quota; nie dodawaj go ponownie przy obliczaniu sald. |
Wiadomości wiadomości (Przekazywanie w czasie rzeczywistym)
Zamiast wielokrotnie zapytwać API REST (GET /messages), aby sprawdzić, czy nadszedł list, skonfiguruj Webhooki, aby nowe wiadomości były wysyłane do Twojego serwera lub automatyzowanego procesu w czasie rzeczywistym.
Wsparte zdarzenia webhook
Każdy webhook może subskrybować jeden lub więcej typów zdarzeń. Twój endpoint otrzymuje powiadomienie o zdarzeniu, gdy jedno z tych wywołań zostanie uruchomione.
Wysyłane w czasie rzeczywistym, gdy nowa wiadomość dotrze do wybranej skrzynki.
Wysyłane, gdy tymczasowa skrzynka pocztowa wygasa i przetwarzanie webhooka jest wstrzymane.
Wysyłane, gdy wygasła skrzynka pocztowa ponownie staje się aktywna zgodnie z zasadami planu.
Wysłane tuż przed usunięciem webhooka i jego skrzynki pocztowej.
Żądane Nagłówki & Weryfikacja Sygnatury HMAC
Każda dostawa webhooku zawiera specjalne nagłówki bezpieczeństwa. Użyj nagłówka X-TempMailg-Signature, aby potwierdzić, że nadchodzące żądania zostały faktycznie wysłane przez TempMailg i nie zostały sfałszowane.
| Nazwa nagłówka | Przykładowa wartość | Opis |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Standardowy identyfikator dla pracownika dostarczania webhooków. |
X-TempMailg-Event |
email.received | Typ zdarzenia, które wywołało tę dostawę. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | Unikalny UUID przypisany do tej próby dostawy. |
X-TempMailg-Timestamp |
1725192000 | Znacznik czasu Unix epoch wskazujący, kiedy żądanie zostało zainicjowane. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | Podpis HMAC-SHA256 obliczony z {timestamp}.{raw_body} przy użyciu twojego sekretu. |
X-TempMailg-Test |
false | Prawda, gdy wysłane przez funkcję "Send Test Ping" w Twoim panelu. |
Podpis obliczany jest za pomocą HMAC z SHA256 nad łańcuchem znaków:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Przykładowy payload zdarzenia (email.received)
Dostarczane jako application/json w ciele żądania HTTP POST.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:17:53+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:17:53+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"
}
}
Przykłady implementacji odbiorcy
Wybierz swój język, aby zobaczyć, jak bezpiecznie odbierać webhooki i weryfikować podpisy 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]);
Obsługiwane platformy i integracje automatyzacji
Webhooki TempMailg działają od razu ze standardowymi punktami końcowymi HTTPS oraz wiodącymi platformami no-code/automatyzacji:
Typowe błędy i rozwiązywanie problemów
Są to najczęstsze kody odpowiedzi, które możesz zobaczyć podczas integrowania API użytkownika.
Nieprawidłowy, brakujący lub odwołany token Bearer.
Własność, uprawnienia funkcji, dostęp do domeny lub rozmiar załącznika uniemożliwiły operację. Sprawdź kod odpowiedzi i komunikat.
Zasób nie został znaleziony na dozwolonej stronie lub nie należy do użytkownika.
Klucz operacji został ponownie użyty z innymi szczegółami, inna operacja jest w toku lub zabezpieczenia skrzynki pocztowej zostały zmienione. Sprawdź kod przed ponowną próbą.
Skrzynka pocztowa wygasła lub jest nieaktywna.
Nieprawidłowe parametry, niedozwolony czas życia, brak dostępnej pojemności aliasu, nieprawidłowa konfiguracja PIN lub brakujący/nieprawidłowy Idempotency-Key uniemożliwiły operację.
Chroniona skrzynka pocztowa wymaga ważnego tokenu X-Mailbox-Unlock o odpowiednim zakresie. Użyj akcji i target_id z odpowiedzi do usunięcia. Wymagania dotyczące blokady lub odzyskiwania muszą zostać rozwiązane przed ponowną próbą.
Limit żądania, wyłączony plan, wyczerpany limit lub okres odnowienia uniemożliwiły operację. Sprawdź przyczynę i nagłówki dostępnego budżetu. Retry-After jest opcjonalny.
Serwer nie mógł zakończyć operacji. W przypadku chronionego tworzenia lub usuwania zachowaj to samo żądanie i Idempotency-Key przy ponownej próbie.
Nie udało się zweryfikować przechowywania ochrony lub koordynacji. Spróbuj ponownie po wskazanym opóźnieniu. Ta odpowiedź nie jest nieudaną płatnością.
Szybka lista kontrolna
- 401 Unauthorized - Brakujący, błędny, odwołany lub niepoprawnie skopiowany token Bearer.
- 403 Forbidden - Aktualny plan nie ma prawa dostępu do API użytkownika w tej chwili.
- 404 Not Found - Brak zasobu lub nieprawidłowy parametr
- 410 Gone / Expired - Skrzynka pocztowa wygasła lub nie jest już aktywna.
- 429 Rate Limited - Sprawdź powód odpowiedzi i nagłówki budżetu. Retry-After ma zastosowanie tylko do limitów czasowych; wyczerpane kredyty lub wyłączony dostęp mogą wymagać zmiany konta.
Zalecany następny krok
Jeśli jesteś zalogowany, otwórz najpierw Zarządzanie interfejsem API i potwierdź stan klucza, limitu, planu dostępu oraz dokładny adres URL bazy API użytkownika przed debugowaniem Twojej aplikacji zewnętrznej.