Rychlý kontrolní seznam nastavení
- Otevřete stránku API Management na svém panelu a vytvořte svůj osobní klíč API.
- Zkopírujte přesnou základní URL uživatelského rozhraní API zobrazenou tam, například https://v1.tempmailg.com/api.
- Odešlete každý požadavek na tento host API s Authorization: Bearer YOUR_USER_API_KEY a Accept: application/json.
- Sledujte svůj měsíční kvótu požadavků ze stejné stránky dashboardu a z hlaviček kvóty, pokud jsou k dispozici v odpovědích uživatelského API. Do kvóty se započítávají pouze úspěšné požadavky s kódem 2xx.
Přístup k API klíči
Přihlaste se k vytvoření svého osobního API klíče a zobrazení aktuálních podrobností kvóty.
Autentizační tok
- Vygenerujte svůj osobní API klíč ze stránky API Management dashboard.
- Odešlete klíč jako Bearer token v každém požadavku.
- Použijte dedikovanou základní URL User API zobrazenou na vaší stránce API Management.
- Obnovte klíč kdykoli chcete zrušit starý a začít používat nový klíč okamžitě.
Požadované hlavičky
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Hlavičky omezení rychlosti a kvóty
Hlavičky omezení rychlosti popisují uvedený rozpočet požadavků. Hlavičky kvóty jsou zahrnuty, když jsou k dispozici informace o kvótě; odmítnutí minutového limitu nepočítají do vašeho celkového měsíčního kvóty.
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— Maximální počet požadavků povolených za minutu (RPM) pro váš plán.X-RateLimit-Remaining— Počet zbývajících požadavků RPM v aktuálním minutovém okně.X-RateLimit-Reset— Unixové časové razítko, kdy se resetuje aktuální minutové okno limitu rychlosti.X-Quota-Limit— Celková měsíční a zakoupená kreditová kapacita pro váš účet.X-Quota-Remaining— Zbývající dostupné požadavky API v aktuálním měsíci.X-Quota-Used— Celkový počet požadavků API spotřebovaných během aktuálního fakturačního období.X-Quota-Reset— Časové razítko ISO‑8601, kdy se resetuje vaše měsíční kvóta.X-RateLimit-Scope— Rozpočet popsaný v hlavičkách: account, ip, status_endpoint, nebo mailbox.X-Mailbox-RateLimit-*— Samostatný rozpočet pro vytváření/aktualizaci poštovní schránky. Úspěšné odpovědi poštovní schránky zachovávají RPM účtu v X-RateLimit-*; odmítnutí pouze poštovní schránky používá rozsah poštovní schránky a vlastní okno opakování.Retry-After— Sekundy, dokud je vhodné provést časově omezený opakovaný pokus. Zakázaný plán nebo vyčerpaná kvóta může vyžadovat změnu účtu, takže tato hlavička není vždy přítomna.503 protection_unavailable— Úložiště nebo koordinace ochrany API jsou dočasně nedostupné. Zkuste to později; nejde o selhání platby ani o odepsání kreditu.
Správa poštovní schránky
Načíst povolené domény, vytvořit nebo přepnout poštovní schránky, vybrat povolené doby platnosti a smazat vlastněné adresy.
Seznam povolených domén
Zobrazte dostupné domény pro vytváření dočasných e‑mailů. Filtrem podle typu zobrazíte pouze bezplatné, prémiové nebo vlastní domény podporované vaším předplatným.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
type
|
query | string | volitelný |
Filtr úrovně domény. Vynechání používá všechny, když je povolen přístup k prémiovým doménám, jinak zdarma. Rozpoznávané hodnoty: free, basic, pro, premium, custom, ultimate, all
Výchozí:
Závislé na účtu
|
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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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 | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.requested_type |
string | Aplikován filtr domény. |
data.plan |
string | Aktuální značka plánu. |
data.plan_name |
string | Čitelný název aktuálního plánu. |
data.allowed_types |
array<string> | Filtry domény dostupné pro tento účet. Rozpoznaný filtr může být i pro váš plán zakázán. |
data.domains |
array | Vybratelné domény po filtrování; prázdné pole je platné. |
data.domains[].domain |
string | Volitelný název domény. |
data.domains[].type |
string | Popisek úrovně čitelné domény. |
data.domains[].custom |
boolean | Zda se jedná o vlastní doménu. |
Vytvořit dočasnou poštovní schránku
Vytvořte vlastní dočasnou poštovní schránku. Vynechte uživatelské jméno a doménu pro náhodné generování, nebo zadejte povolené vlastní uživatelské jméno a povolenou doménu. Parametr provider může vybrat generování aliasu pro Gmail nebo Outlook.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
username
|
body | string | volitelný |
Volitelný vlastní uživatelský název: 2 až 64 ASCII písmen, číslic, teček, podtržítek nebo pomlček. Vyžaduje oprávnění plánu; custom_username je také akceptován.
Výchozí:
Náhodně vygenerováno
|
domain
|
body | string | volitelný |
Jedna z povolených domén vrácených GET /domains. Vynechání vybere náhodnou povolenou doménu.
Výchozí:
Náhodná povolená doména
|
lifetime
|
body | string | volitelný |
povolené hodnoty:
10m — 10 minut
1h — 1 hodina
2h — 2 hodiny
1d — 1 den
1w — 1 Týden
1m — 30 dní
3m — 90 dní
6m — 180 dní
1y — 365 dní
unlimited — Neomezený
Výchozí:
Výchozí životnost plánu
|
provider
|
body | string | volitelný |
Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias.
Výchozí:
standard
|
pin_enabled
|
body | boolean | volitelný |
Volitelná ochrana PIN pro novou poštovní schránku, pokud to váš plán umožňuje. Nemění PIN existující poštovní schránky.
Výchozí:
false
|
pin
|
body | string | volitelný |
Vyžadováno, když je pin_enabled true: PIN o 6 až 8 číslicích, odeslaný jako řetězec pro zachování úvodních nul.
|
pin_confirmation
|
body | string | volitelný |
Vyžadováno, když je pin_enabled nastaven na true. Musí přesně odpovídat pinu.
|
Idempotency-Key
|
header | string | volitelný |
Vyžadováno pro tvorbu nebo mazání chráněné PIN kódem: stabilní klíč o délce 16 až 128 znaků. Opakujte stejný požadavek se stejným klíčem, aby nedošlo k duplicitní práci.
|
username (vlastní uživatelské jméno, pokud to plán umožňuje), domain (povolená doména, např. example.com), lifetime (povolené hodnoty: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Vynechte dobu platnosti nebo ji nechte prázdnou, aby se použila výchozí doba platnosti e‑mailu nastavená pro váš aktuální měsíční/roční plán. Pošlete povolenou dobu platnosti, například 1 h, abyste přepsali výchozí hodnotu. Neomezené se používá pouze, pokud je nastaveno jako výchozí v plánu nebo je výslovně požadováno a povoleno. Parametry těla mailbox_lifetime a email_lifetime jsou také akceptovány; první neprázdná hodnota vyhrává v tomto pořadí: lifetime, mailbox_lifetime, email_lifetime. Neplatné nebo nepovolené hodnoty vrací HTTP 422 místo tichého výběru výchozí hodnoty.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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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:45+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:45+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.id |
integer | ID poštovní schránky. Generovaná ID, adresy a tokeny se liší pro každou poštovní schránku. |
data.pin_protected |
boolean | Zda má tato poštovní schránka ochranu PIN. Žádný PIN ani hash PIN není vrácen. |
data.email |
string | Vygenerována úplná adresa poštovní schránky. |
data.domain |
string | Doména generované poštovní schránky. |
data.provider |
string | Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias. |
data.expire_at |
string|null | Platná expirace jako časové razítko ISO-8601 nebo null pro neomezenou poštovní schránku. |
data.expires_in_seconds |
number|null | Nezáporné sekundy zbývající při výpočtu; zlomkové sekundy jsou možné. Null znamená neomezené, ne nulu. |
data.mailbox_state |
string | Aktuální stav poštovní schránky: aktivní, pozastavená, vypršená nebo neaktivní. |
data.receiving_enabled |
boolean | Zda tato poštovní schránka v současné době přijímá příchozí zprávy. |
data.message_count |
integer | Známý celkový počet zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.unread_message_count |
integer | Známý počet nepřečtených zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.last_message_received_at |
string|null | Poslední známý čas přijaté zprávy ve formátu ISO-8601, nebo null, pokud není k dispozici. |
data.message_count_synced_at |
string|null | Čas poslední synchronizace počtu zpráv ve formátu ISO-8601 nebo null před synchronizací. |
data.created_at |
string|null | Čas vytvoření poštovní schránky ve formátu ISO-8601. |
data.email_token |
string | Neprůhledná šifrovaná reference poštovní schránky. Nenahrazuje ověřování typu Bearer, kontroly vlastnictví ani autorizaci PIN. |
data.pin_grant |
object | Podmíněně: aktivní vytvoření poštovní schránky chráněné PIN kódem vrací toto oprávnění ke čtení; běžné nechráněné vytvoření jej vynechává. |
data.pin_grant.mailbox_id |
integer | ID poštovní schránky, ke které je vázáno podmíněné oprávnění ke čtení. |
data.pin_grant.unlock_token |
string | Neprůhledný token pro čtení pro X-Mailbox-Unlock se stejnými přihlašovacími údaji vlastníka. Uchovávejte jej soukromě a v paměti; oprávnění ke čtení neautorizuje smazání. |
data.pin_grant.scope |
string | Rozsah čtení pro podmíněné udělení vytvoření. |
data.pin_grant.idle_timeout_seconds |
integer | Povolený čas nečinnosti pro oprávnění čtení, obvykle 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maximální životnost oprávnění ke čtení, obvykle 86400 sekund. |
data.pin_grant.expires_at |
string | Aktuální vypršení oprávnění ke čtení ve formátu ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Absolutní vypršení oprávnění ke čtení ve formátu ISO-8601. Změny zabezpečení mohou oprávnění odebrat dříve. |
Aktualizovat / Přepnout poštovní schránku
Vytvořte nebo vyberte poštovní schránku na novém uživatelském jménu a doméně po ověření vlastnictví aktuální poštovní schránky. Tím se nepřejmenuje stará poštovní schránka ani nezmění její životnost na místě. Pokud se cíl liší, stará poštovní schránka zůstane v historii a může být pozastavena omezeními aktivních schránek. Opětovné použití vlastního aktivního cíle znovu použije požadovanou životnost nebo výchozí nastavení plánu.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
email
|
path | string | povinné |
Aktuální úplná e‑mailová adresa vlastněné poštovní schránky, kterou chcete přepnout. URL‑kódujte každý segment cesty; znak plus kódujte jako %2B.
|
username
|
path | string | povinné |
Nové požadované uživatelské jméno: 2 až 64 alfanumerických znaků; podléhá oprávnění pro vlastní uživatelská jména.
|
domain
|
path | string | povinné |
Nový povolený název domény.
|
lifetime
|
body | string | volitelný |
povolené hodnoty:
10m — 10 minut
1h — 1 hodina
2h — 2 hodiny
1d — 1 den
1w — 1 Týden
1m — 30 dní
3m — 90 dní
6m — 180 dní
1y — 365 dní
unlimited — Neomezený
Výchozí:
Výchozí životnost plánu
|
pin_enabled
|
body | boolean | volitelný |
Volitelná ochrana PIN pro novou poštovní schránku, pokud to váš plán umožňuje. Nemění PIN existující poštovní schránky.
Výchozí:
false
|
pin
|
body | string | volitelný |
Vyžadováno, když je pin_enabled true: PIN o 6 až 8 číslicích, odeslaný jako řetězec pro zachování úvodních nul.
|
pin_confirmation
|
body | string | volitelný |
Vyžadováno, když je pin_enabled nastaven na true. Musí přesně odpovídat pinu.
|
Idempotency-Key
|
header | string | volitelný |
Vyžadováno pro tvorbu nebo mazání chráněné PIN kódem: stabilní klíč o délce 16 až 128 znaků. Opakujte stejný požadavek se stejným klíčem, aby nedošlo k duplicitní práci.
|
X-Mailbox-Unlock
|
header | string | volitelný |
Záhlaví, pouze chráněné poštovní schránky: použijte odemknutí tokenu pro čtení. Nejprve pošlete POST pin a scope=read na URL pro odemknutí PIN. Zachovejte své běžné ověření Bearer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (povolené hodnoty: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Vynechte dobu platnosti nebo ji nechte prázdnou, aby se použila výchozí doba platnosti e‑mailu nastavená pro váš aktuální měsíční/roční plán. Pošlete povolenou dobu platnosti, například 1 h, abyste přepsali výchozí hodnotu. Neomezené se používá pouze, pokud je nastaveno jako výchozí v plánu nebo je výslovně požadováno a povoleno. Parametry těla mailbox_lifetime a email_lifetime jsou také akceptovány; první neprázdná hodnota vyhrává v tomto pořadí: lifetime, mailbox_lifetime, email_lifetime. Neplatné nebo nepovolené hodnoty vrací HTTP 422 místo tichého výběru výchozí hodnoty.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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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:45+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:45+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.id |
integer | ID poštovní schránky. Generovaná ID, adresy a tokeny se liší pro každou poštovní schránku. |
data.pin_protected |
boolean | Zda má tato poštovní schránka ochranu PIN. Žádný PIN ani hash PIN není vrácen. |
data.email |
string | Vygenerována úplná adresa poštovní schránky. |
data.domain |
string | Doména generované poštovní schránky. |
data.provider |
string | Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias. |
data.expire_at |
string|null | Platná expirace jako časové razítko ISO-8601 nebo null pro neomezenou poštovní schránku. |
data.expires_in_seconds |
number|null | Nezáporné sekundy zbývající při výpočtu; zlomkové sekundy jsou možné. Null znamená neomezené, ne nulu. |
data.mailbox_state |
string | Aktuální stav poštovní schránky: aktivní, pozastavená, vypršená nebo neaktivní. |
data.receiving_enabled |
boolean | Zda tato poštovní schránka v současné době přijímá příchozí zprávy. |
data.message_count |
integer | Známý celkový počet zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.unread_message_count |
integer | Známý počet nepřečtených zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.last_message_received_at |
string|null | Poslední známý čas přijaté zprávy ve formátu ISO-8601, nebo null, pokud není k dispozici. |
data.message_count_synced_at |
string|null | Čas poslední synchronizace počtu zpráv ve formátu ISO-8601 nebo null před synchronizací. |
data.created_at |
string|null | Čas vytvoření poštovní schránky ve formátu ISO-8601. |
data.email_token |
string | Neprůhledná šifrovaná reference poštovní schránky. Nenahrazuje ověřování typu Bearer, kontroly vlastnictví ani autorizaci PIN. |
data.pin_grant |
object | Podmíněně: aktivní vytvoření poštovní schránky chráněné PIN kódem vrací toto oprávnění ke čtení; běžné nechráněné vytvoření jej vynechává. |
data.pin_grant.mailbox_id |
integer | ID poštovní schránky, ke které je vázáno podmíněné oprávnění ke čtení. |
data.pin_grant.unlock_token |
string | Neprůhledný token pro čtení pro X-Mailbox-Unlock se stejnými přihlašovacími údaji vlastníka. Uchovávejte jej soukromě a v paměti; oprávnění ke čtení neautorizuje smazání. |
data.pin_grant.scope |
string | Rozsah čtení pro podmíněné udělení vytvoření. |
data.pin_grant.idle_timeout_seconds |
integer | Povolený čas nečinnosti pro oprávnění čtení, obvykle 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maximální životnost oprávnění ke čtení, obvykle 86400 sekund. |
data.pin_grant.expires_at |
string | Aktuální vypršení oprávnění ke čtení ve formátu ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Absolutní vypršení oprávnění ke čtení ve formátu ISO-8601. Změny zabezpečení mohou oprávnění odebrat dříve. |
Smazat poštovní schránku
Odstraňte vlastněnou poštovní schránku a spusťte její vyčištění zpráv a souborů. Uchovávané záznamy poštovní schránky mohou být interně měkce smazány; adresa již není použitelná přes API.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
email
|
path | string | povinné |
Úplná e‑mailová adresa vlastněné poštovní schránky, kterou chcete smazat. URL‑kódujte adresu; znak plus kódujte jako %2B.
|
X-Mailbox-Unlock
|
header | string | volitelný |
Hlavička, pouze chráněné poštovní schránky: použijte jednorázový delete unlock_token. Nejprve POST pin, scope=delete a action/target_id vrácené odpovědí 423 na PIN unlock URL. Token pro čtení nemůže mazat. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | volitelný |
Vyžadováno pro tvorbu nebo mazání chráněné PIN kódem: stabilní klíč o délce 16 až 128 znaků. Opakujte stejný požadavek se stejným klíčem, aby nedošlo k duplicitní práci.
|
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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
message |
string | Výsledek smazání. Chybějící zdroj vrací HTTP 404. |
Gmail & Outlook aliasy
Vytvořte aliasové poštovní schránky s vysokou reputací pro Gmail a Outlook/Hotmail.
Vytvořit alias Gmailu
Vytvořte novou dočasnou poštovní schránku aliasu Gmail, která je vlastněna ověřeným uživatelem.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
mode
|
body | string | volitelný |
Režim generování: auto, dot, plus nebo plus_dot. Také přijímá gmail_alias_mode. Pokud není výběr stylu povolen, použije se auto.
Výchozí:
auto
|
username
|
body | string | volitelný |
Volitelná vlastní přípona aliasu: 2 až 32 znaků ASCII (písmen nebo číslic), normalizováno na malá písmena; podléhá oprávnění funkce. Také přijímá custom_username nebo alias_username.
Výchozí:
Automaticky generováno
|
domain
|
body | string | volitelný |
Použijte náhodnou, gmail.com nebo googlemail.com; alias_domain je také akceptováno. Vynechání nebo nedostupná oprávnění výběru domény používá náhodnou.
Výchozí:
random
|
lifetime
|
body | string | volitelný |
povolené hodnoty:
10m — 10 minut
1h — 1 hodina
2h — 2 hodiny
1d — 1 den
1w — 1 Týden
1m — 30 dní
3m — 90 dní
6m — 180 dní
1y — 365 dní
unlimited — Neomezený
Výchozí:
Výchozí životnost plánu
|
pin_enabled
|
body | boolean | volitelný |
Volitelná ochrana PIN pro novou poštovní schránku, pokud to váš plán umožňuje. Nemění PIN existující poštovní schránky.
Výchozí:
false
|
pin
|
body | string | volitelný |
Vyžadováno, když je pin_enabled true: PIN o 6 až 8 číslicích, odeslaný jako řetězec pro zachování úvodních nul.
|
pin_confirmation
|
body | string | volitelný |
Vyžadováno, když je pin_enabled nastaven na true. Musí přesně odpovídat pinu.
|
Idempotency-Key
|
header | string | volitelný |
Vyžadováno pro tvorbu nebo mazání chráněné PIN kódem: stabilní klíč o délce 16 až 128 znaků. Opakujte stejný požadavek se stejným klíčem, aby nedošlo k duplicitní práci.
|
mode (auto, dot, plus, plus_dot), username (vlastní alias uživatelské jméno), domain (např. gmail.com, googlemail.com), lifetime (povolené hodnoty: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Vynechte dobu platnosti nebo ji nechte prázdnou, aby se použila výchozí doba platnosti e‑mailu nastavená pro váš aktuální měsíční/roční plán. Pošlete povolenou dobu platnosti, například 1 h, abyste přepsali výchozí hodnotu. Neomezené se používá pouze, pokud je nastaveno jako výchozí v plánu nebo je výslovně požadováno a povoleno. Parametry těla mailbox_lifetime a email_lifetime jsou také akceptovány; první neprázdná hodnota vyhrává v tomto pořadí: lifetime, mailbox_lifetime, email_lifetime. Neplatné nebo nepovolené hodnoty vrací HTTP 422 místo tichého výběru výchozí hodnoty.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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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:45+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:45+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.id |
integer | ID poštovní schránky. Generovaná ID, adresy a tokeny se liší pro každou poštovní schránku. |
data.pin_protected |
boolean | Zda má tato poštovní schránka ochranu PIN. Žádný PIN ani hash PIN není vrácen. |
data.email |
string | Vygenerována úplná adresa poštovní schránky. |
data.domain |
string | Doména generované poštovní schránky. |
data.provider |
string | Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias. |
data.expire_at |
string|null | Platná expirace jako časové razítko ISO-8601 nebo null pro neomezenou poštovní schránku. |
data.expires_in_seconds |
number|null | Nezáporné sekundy zbývající při výpočtu; zlomkové sekundy jsou možné. Null znamená neomezené, ne nulu. |
data.mailbox_state |
string | Aktuální stav poštovní schránky: aktivní, pozastavená, vypršená nebo neaktivní. |
data.receiving_enabled |
boolean | Zda tato poštovní schránka v současné době přijímá příchozí zprávy. |
data.message_count |
integer | Známý celkový počet zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.unread_message_count |
integer | Známý počet nepřečtených zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.last_message_received_at |
string|null | Poslední známý čas přijaté zprávy ve formátu ISO-8601, nebo null, pokud není k dispozici. |
data.message_count_synced_at |
string|null | Čas poslední synchronizace počtu zpráv ve formátu ISO-8601 nebo null před synchronizací. |
data.created_at |
string|null | Čas vytvoření poštovní schránky ve formátu ISO-8601. |
data.email_token |
string | Neprůhledná šifrovaná reference poštovní schránky. Nenahrazuje ověřování typu Bearer, kontroly vlastnictví ani autorizaci PIN. |
data.pin_grant |
object | Podmíněně: aktivní vytvoření poštovní schránky chráněné PIN kódem vrací toto oprávnění ke čtení; běžné nechráněné vytvoření jej vynechává. |
data.pin_grant.mailbox_id |
integer | ID poštovní schránky, ke které je vázáno podmíněné oprávnění ke čtení. |
data.pin_grant.unlock_token |
string | Neprůhledný token pro čtení pro X-Mailbox-Unlock se stejnými přihlašovacími údaji vlastníka. Uchovávejte jej soukromě a v paměti; oprávnění ke čtení neautorizuje smazání. |
data.pin_grant.scope |
string | Rozsah čtení pro podmíněné udělení vytvoření. |
data.pin_grant.idle_timeout_seconds |
integer | Povolený čas nečinnosti pro oprávnění čtení, obvykle 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maximální životnost oprávnění ke čtení, obvykle 86400 sekund. |
data.pin_grant.expires_at |
string | Aktuální vypršení oprávnění ke čtení ve formátu ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Absolutní vypršení oprávnění ke čtení ve formátu ISO-8601. Změny zabezpečení mohou oprávnění odebrat dříve. |
Aliasové domény Outlooku
Načíst aktivní domény aliasů Outlook / Hotmail dostupné pro generování poštovní schránky.
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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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 | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.domains |
array | Aktivní domény Outlook/Hotmail; prázdné pole je platné. |
data.domains[].domain |
string | Dostupný název domény. |
data.domains[].type |
string | Čitelný popisek poskytovatele. |
data.domains[].selectable |
boolean | Zda si váš účet může výslovně vybrat tuto doménu. |
data.domains[].locked |
boolean | Zda je explicitní výběr domény pro váš účet uzamčen. |
data.domains[].disabled_reason |
string|null | Důvod, proč je výběr domény uzamčen, nebo null, když je volitelný. |
Vytvořit Outlook alias
Vytvořte novou dočasnou poštovní schránku aliasu Outlook / Hotmail, která patří ověřenému uživateli.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
domain
|
body | string | volitelný |
Použijte náhodnou doménu nebo doménu z GET /outlook-alias/domains; outlook_alias_domain je také akceptována. Bez oprávnění k výběru se použije náhodná.
Výchozí:
Náhodná dostupná doména
|
username
|
body | string | volitelný |
Volitelná vlastní přípona aliasu: 2 až 32 znaků ASCII (písmen nebo číslic), normalizováno na malá písmena; podléhá oprávnění funkce. Také přijímá custom_username nebo alias_username.
Výchozí:
Automaticky generováno
|
lifetime
|
body | string | volitelný |
povolené hodnoty:
10m — 10 minut
1h — 1 hodina
2h — 2 hodiny
1d — 1 den
1w — 1 Týden
1m — 30 dní
3m — 90 dní
6m — 180 dní
1y — 365 dní
unlimited — Neomezený
Výchozí:
Výchozí životnost plánu
|
pin_enabled
|
body | boolean | volitelný |
Volitelná ochrana PIN pro novou poštovní schránku, pokud to váš plán umožňuje. Nemění PIN existující poštovní schránky.
Výchozí:
false
|
pin
|
body | string | volitelný |
Vyžadováno, když je pin_enabled true: PIN o 6 až 8 číslicích, odeslaný jako řetězec pro zachování úvodních nul.
|
pin_confirmation
|
body | string | volitelný |
Vyžadováno, když je pin_enabled nastaven na true. Musí přesně odpovídat pinu.
|
Idempotency-Key
|
header | string | volitelný |
Vyžadováno pro tvorbu nebo mazání chráněné PIN kódem: stabilní klíč o délce 16 až 128 znaků. Opakujte stejný požadavek se stejným klíčem, aby nedošlo k duplicitní práci.
|
domain (např. outlook.com, hotmail.com), username (vlastní alias uživatelské jméno), lifetime (povolené hodnoty: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Vynechte dobu platnosti nebo ji nechte prázdnou, aby se použila výchozí doba platnosti e‑mailu nastavená pro váš aktuální měsíční/roční plán. Pošlete povolenou dobu platnosti, například 1 h, abyste přepsali výchozí hodnotu. Neomezené se používá pouze, pokud je nastaveno jako výchozí v plánu nebo je výslovně požadováno a povoleno. Parametry těla mailbox_lifetime a email_lifetime jsou také akceptovány; první neprázdná hodnota vyhrává v tomto pořadí: lifetime, mailbox_lifetime, email_lifetime. Neplatné nebo nepovolené hodnoty vrací HTTP 422 místo tichého výběru výchozí hodnoty.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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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:45+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:45+00:00",
"email_token": "encrypted-email-token"
}
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.id |
integer | ID poštovní schránky. Generovaná ID, adresy a tokeny se liší pro každou poštovní schránku. |
data.pin_protected |
boolean | Zda má tato poštovní schránka ochranu PIN. Žádný PIN ani hash PIN není vrácen. |
data.email |
string | Vygenerována úplná adresa poštovní schránky. |
data.domain |
string | Doména generované poštovní schránky. |
data.provider |
string | Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias. |
data.expire_at |
string|null | Platná expirace jako časové razítko ISO-8601 nebo null pro neomezenou poštovní schránku. |
data.expires_in_seconds |
number|null | Nezáporné sekundy zbývající při výpočtu; zlomkové sekundy jsou možné. Null znamená neomezené, ne nulu. |
data.mailbox_state |
string | Aktuální stav poštovní schránky: aktivní, pozastavená, vypršená nebo neaktivní. |
data.receiving_enabled |
boolean | Zda tato poštovní schránka v současné době přijímá příchozí zprávy. |
data.message_count |
integer | Známý celkový počet zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.unread_message_count |
integer | Známý počet nepřečtených zpráv; může odrážet poslední synchronizaci poštovní schránky. |
data.last_message_received_at |
string|null | Poslední známý čas přijaté zprávy ve formátu ISO-8601, nebo null, pokud není k dispozici. |
data.message_count_synced_at |
string|null | Čas poslední synchronizace počtu zpráv ve formátu ISO-8601 nebo null před synchronizací. |
data.created_at |
string|null | Čas vytvoření poštovní schránky ve formátu ISO-8601. |
data.email_token |
string | Neprůhledná šifrovaná reference poštovní schránky. Nenahrazuje ověřování typu Bearer, kontroly vlastnictví ani autorizaci PIN. |
data.pin_grant |
object | Podmíněně: aktivní vytvoření poštovní schránky chráněné PIN kódem vrací toto oprávnění ke čtení; běžné nechráněné vytvoření jej vynechává. |
data.pin_grant.mailbox_id |
integer | ID poštovní schránky, ke které je vázáno podmíněné oprávnění ke čtení. |
data.pin_grant.unlock_token |
string | Neprůhledný token pro čtení pro X-Mailbox-Unlock se stejnými přihlašovacími údaji vlastníka. Uchovávejte jej soukromě a v paměti; oprávnění ke čtení neautorizuje smazání. |
data.pin_grant.scope |
string | Rozsah čtení pro podmíněné udělení vytvoření. |
data.pin_grant.idle_timeout_seconds |
integer | Povolený čas nečinnosti pro oprávnění čtení, obvykle 3600 sekund. |
data.pin_grant.absolute_timeout_seconds |
integer | Maximální životnost oprávnění ke čtení, obvykle 86400 sekund. |
data.pin_grant.expires_at |
string | Aktuální vypršení oprávnění ke čtení ve formátu ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Absolutní vypršení oprávnění ke čtení ve formátu ISO-8601. Změny zabezpečení mohou oprávnění odebrat dříve. |
Zprávy & Přílohy
Načíst příchozí schránky, číst kompletní HTML/textové zprávy a streamovat přílohy.
Vypsat zprávy poštovní schránky
Získejte dostupné souhrny zpráv a metadata poštovní schránky. Standardní skenování doručené pošty vrací nedávnou dávku až 25 zpráv; nejde o stránkovaný endpoint s kompletní historií. Použijte GET /messages/{messageId} pro úplné tělo zprávy a přílohy.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
email
|
query | string | povinné |
Úplná e-mailová adresa vlastněné poštovní schránky, ze které číst zprávy. URL-kódujte hodnotu dotazu; znak plus kódujte jako %2B.
|
X-Mailbox-Unlock
|
header | string | volitelný |
Záhlaví, pouze chráněné poštovní schránky: použijte odemknutí tokenu pro čtení. Nejprve pošlete POST pin a scope=read na URL pro odemknutí PIN. Zachovejte své běžné ověření 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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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:45",
"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:45+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:45+00:00",
"message_count_synced_at": "2026-11-19T02:17:45+00:00"
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
mailbox |
string | Adresa poštovní schránky, jejíž zprávy byly požadovány. |
email_token |
string | Neprůhledná šifrovaná reference poštovní schránky; stále je vyžadována běžná autentizace. |
mailbox_provider |
string | Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias. |
messages |
array | Souhrny zpráv. Prázdná doručená pošta vrací prázdné pole; načtěte jednu zprávu pro její tělo a přílohy. |
expire_at |
string|null | Platná expirace jako časové razítko ISO-8601 nebo null pro neomezenou poštovní schránku. |
expires_in_seconds |
number|null | Nezáporné sekundy zbývající při výpočtu; zlomkové sekundy jsou možné. Null znamená neomezené, ne nulu. |
mailbox_state |
string | Aktuální stav poštovní schránky: aktivní, pozastavená, vypršená nebo neaktivní. |
receiving_enabled |
boolean | Zda tato poštovní schránka v současné době přijímá příchozí zprávy. |
message_count |
integer | Známý celkový počet zpráv; může odrážet poslední synchronizaci poštovní schránky. |
unread_message_count |
integer | Známý počet nepřečtených zpráv; může odrážet poslední synchronizaci poštovní schránky. |
last_message_received_at |
string|null | Poslední známý čas přijaté zprávy ve formátu ISO-8601, nebo null, pokud není k dispozici. |
message_count_synced_at |
string|null | Čas poslední synchronizace počtu zpráv ve formátu ISO-8601 nebo null před synchronizací. |
mailbox_limit.limit |
integer | Aktivní limit poštovní schránky pro tohoto poskytovatele; -1 znamená neomezený. |
mailbox_limit.limit_label |
string | Zobrazovaný štítek pro limit poštovní schránky. |
mailbox_limit.active_count |
integer | Počet aktivních poštovních schránek pro tohoto poskytovatele. |
mailbox_limit.paused_count |
integer | Počet pozastavených poštovních schránek pro tohoto poskytovatele. |
mailbox_limit.paused_mailboxes |
array<string> | Adresy pozastaveny kvůli limitu poštovní schránky. |
mailbox_limit.remaining |
integer | Zbývající aktivní sloty poštovních schránek; -1 znamená neomezeně. Toto není kvóta požadavků API. |
mailbox_limit.remaining_label |
string | Zobrazit popisek pro zbývající sloty poštovní schránky. |
mailbox_limit.reached |
boolean | Zda byl dosažen limit aktivních poštovních schránek. |
mailbox_limit.blocked |
boolean | Zda je limit aktivních poštovních schránek nulový. |
mailbox_limit.provider |
string|null | Poskytovatel, na který se vztahuje limit poštovní schránky. |
messages[].id |
string | Neprůhledné ID zprávy používané koncovými body pro jednotlivé zprávy, mazání a přílohy. |
messages[].is_seen |
boolean | Zda je zpráva označena jako přečtená. |
messages[].subject |
string | Předmět zprávy. |
messages[].from |
string | Zobrazované jméno nebo adresa odesílatele. |
messages[].from_email |
string | E‑mailová adresa odesílatele. |
messages[].receivedAt |
string | Čas přijetí v časovém pásmu aplikace, formátovaný jako YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Detekován jednorázový kód, pokud je k dispozici a povolen; jinak null. |
messages[].otp_locked |
boolean | Zda je detekovaný jednorázový kód skrytý oprávněními funkce. |
messages[].verification_link |
string|null | Detekována ověřovací URL, pokud je k dispozici a povoleno; jinak null. |
messages[].verification_link_locked |
boolean | Zda je detekovaný ověřovací odkaz skrytý oprávněními funkce. |
messages[].from_name |
string|null | Pole souhrnu Outlook: jméno původního odesílatele. Chybí ve standardních a Gmail souhrnech. |
messages[].snippet |
string|null | Pole souhrnu Outlook: krátký náhled zprávy. |
messages[].received_at |
string|null | Pole souhrnu Outlook: čas přijetí ve formátu ISO-8601, pokud je znám. |
messages[].has_attachments |
boolean | Pole souhrnu Outlook: zda existují metadata přílohy. Dostupnost stahování je kontrolována samostatně. |
Získat jednotlivou zprávu
Načtěte vlastněnou zprávu podle její neprůhledné ID zprávy. Vrací formáty těla a metadata příloh. Pole těla závisí na formátu zprávy; Outlook přidává níže uvedená pole specifická pro poskytovatele.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
messageId
|
path | string | povinné |
Jedinečné ID zprávy vrácené v seznamu zpráv.
|
X-Mailbox-Unlock
|
header | string | volitelný |
Záhlaví, pouze chráněné poštovní schránky: použijte odemknutí tokenu pro čtení. Nejprve pošlete POST pin a scope=read na URL pro odemknutí PIN. Zachovejte své běžné ověření 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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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:45",
"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 | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
data.id |
string | Neprůhledné ID zprávy. |
data.is_seen |
boolean | Stav přečtení zprávy. Čtení může označit jako zobrazené; uložená data mohou odrážet dřívější stav. |
data.subject |
string | Předmět zprávy. |
data.from |
string | Zobrazované jméno nebo adresa odesílatele. |
data.from_email |
string | E‑mailová adresa odesílatele. |
data.to |
string | Adresa poštovní schránky příjemce. |
data.mailbox_provider |
string | Poskytovatel poštovní schránky: standard, gmail_alias nebo outlook_alias. |
data.receivedAt |
string | Čas přijetí v časovém pásmu aplikace, formátovaný jako YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Zda má zpráva HTML tělo. |
data.html_content |
string | HTML tělo, pokud je přítomno. Standardní zprávy bez HTML mohou toto pole vynechat. Obsah zprávy považujte za nedůvěryhodný. |
data.text_content |
string | Textové tělo, pokud je přítomno; Standardní zprávy mohou obsahovat escapovaný text v elementu pre nebo toto pole vynechat. |
data.content |
string | Preferované tělo pro zobrazení, obvykle HTML, pokud je k dispozici. |
data.attachments |
array | Metadata přílohy, nebo prázdné pole. Stahování vyžaduje běžné ověření a příslušné oprávnění PIN kódem. |
data.attachments[].name |
string | Název souboru, který se má URL‑kódovat jako jediný segment cesty při stahování. |
data.attachments[].size |
integer | Velikost přílohy v bajtech. |
data.attachments[].url |
string | URL pro stažení API ověřeného uživatele byla přidána k přílohám s názvem souboru. URL nezaručuje, že je místní soubor k dispozici. |
data.attachments[].extension |
string | Standardní/Gmail metadata pole: přípona souboru, pokud je zadána. |
data.attachments[].id |
string | Pole metadat Outlook: ID přílohy poskytovatele. |
data.attachments[].content_type |
string | Pole metadat Outlook: MIME typ obsahu. |
data.from_name |
string|null | Pole podrobností Outlook: původní jméno odesílatele. |
data.to_email |
string|null | Pole podrobností Outlook: původní adresa příjemce. |
data.received_at |
string|null | Pole podrobností Outlook: čas přijetí ve formátu ISO-8601. |
data.has_html |
boolean | Pole podrobností Outlook: zda existuje HTML tělo. |
Smazat zprávu
Smazat jednu vlastnilou zprávu.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
messageId
|
path | string | povinné |
Jedinečný řetězec ID zprávy k trvalému smazání.
|
X-Mailbox-Unlock
|
header | string | volitelný |
Hlavička, pouze chráněné poštovní schránky: použijte jednorázový delete unlock_token. Nejprve POST pin, scope=delete a action/target_id vrácené odpovědí 423 na PIN unlock URL. Token pro čtení nemůže mazat. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | volitelný |
Vyžadováno pro tvorbu nebo mazání chráněné PIN kódem: stabilní klíč o délce 16 až 128 znaků. Opakujte stejný požadavek se stejným klíčem, aby nedošlo k duplicitní práci.
|
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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Pole | Typ | Popis |
|---|---|---|
status |
boolean | Zda operace byla úspěšná. |
message |
string | Výsledek smazání. Chybějící zdroj vrací HTTP 404. |
Stáhnout přílohu
Stáhnout příloha z vlastního zprávy.
| Parametr | Umístění | Typ | Stav | Popis |
|---|---|---|---|---|
messageId
|
path | string | povinné |
ID zprávy obsahující soubor.
|
filename
|
path | string | povinné |
Název souboru a přípona přílohy ke stažení.
|
X-Mailbox-Unlock
|
header | string | volitelný |
Záhlaví, pouze chráněné poštovní schránky: použijte odemknutí tokenu pro čtení. Nejprve pošlete POST pin a scope=read na URL pro odemknutí PIN. Zachovejte své běžné ověření 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 | Popis |
|---|---|---|
Content-Disposition |
header | Úspěšná odpověď stáhne požadovaný název souboru. |
body |
binary | Při úspěchu souborové bajty, ne JSON. Chyby vrací JSON s ne‑2xx stavem. |
Limity rychlosti a kvóty
Sledujte rozpočty požadavků v reálném čase, limity rychlosti a kvóty účtu, aniž byste spotřebovávali kredity.
Limit rychlosti a kvóta
Zkontrolujte svůj aktuální limit rychlosti a stav kvóty, aniž byste spotřebovali jakékoli využití API. Tento koncový bod je bez kvóty a neodečítá měsíční kredity API (limit ochrany proti zneužití: 60 požadavků/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'
Ilustrační odpověď používající syntetická data. ID, adresy, tokeny, časová razítka, limity plánu a počty se liší. Vzorkové životnosti nepřepisují výchozí nastavení vašeho plánu. Popisy polí odpovědi identifikují pole, která mohou být null, a poskytovatelsky specifické pole.
Příklad odpovědi
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 | Popis |
|---|---|---|
data.limit |
integer|string | Limit požadavků na účet za minutu. Řetězec unlimited označuje neomezený minutový rozpočet; to je nezávislé na měsíční kvótě. |
data.remaining |
integer|string | Zbývající minutové sloty účtu, nebo řetězec unlimited. Kladná hodnota neznamená, že zůstávají kredity API. |
data.reset |
integer | Sekundy pro minutové okno účtu, ne pro měsíční reset kvóty. Vypnuté nebo neomezené minutové rozpočty mohou zachovat nominální hodnotu 60 sekund; to neznamená, že po čekání získáte přístup. |
data.plan |
string | Aktuální značka plánu. Čitelný název plánu je poskytnut samostatně v data.quota.plan_name. |
data.quota.enabled |
boolean | Zda je povolen globální a plánový/kreditní přístup k API. Toto neindikuje zbývající kapacitu ani nenahrazuje uživatelský přepínač API. |
data.quota.user_api_status |
boolean | Zda uživatel povolil svůj přepínač User API. Operace vyžadují tento přepínač, stejně jako povolený přístup a dostupnou kapacitu. |
data.quota.plan_name |
string | Čitelný název aktuálního plánu. |
data.quota.period |
string | Období používání kalendářního měsíce ve formátu YYYY-MM, s použitím časového pásma aplikace; ne nutně fakturační období předplatného. |
data.quota.base_limit |
integer | Základní měsíční přidělení plánu. Hodnota -1 znamená neomezeně. |
data.quota.extra_requests |
integer | Další měsíční příděl byl přidělen pro aktuální období používání; odděleně od zakoupených kreditů. |
data.quota.monthly_limit |
integer | Základní přidělení plus extra požadavky aktuálního období. Hodnota -1 znamená neomezený. Zakoupené kredity nejsou zahrnuty. |
data.quota.monthly_remaining |
integer|null | Zbývající konečný měsíční limit, nebo null, pokud je měsíční kvóta neomezená. Null nesmí být interpretováno jako nula. |
data.quota.used |
integer | Úspěšné, započítané operace API v aktuálním období používání, včetně operací využívajících kredity. Kontroly stavu nezvyšují tuto hodnotu. |
data.quota.purchased_credits |
integer | Aktuální zůstatek kreditů, včetně bonusových kreditů aktivního plánu. Bonusové kredity nesmí být přidány k tomuto zůstatku podruhé. |
data.quota.bonus_credits |
integer | Aktivní část bonusu plánu v kreditu; rozpis zakoupených kreditů, nikoli další kapacita. |
data.quota.direct_purchased_credits |
integer | Zůstatek kreditu bez části aktivního plánu-bonusu. Tato hodnota plus bonus_credits se rovná purchased_credits. |
data.quota.remaining |
integer|null | Měsíční zbývající přidělení plus aktuální kreditní zůstatek, bez dvojího započítání bonusů. Null znamená neomezený měsíční kvóta. Individuální oprávnění funkcí a další limity požadavků stále platí. |
data.quota.unlimited |
boolean | Zda je měsíční kvóta neomezená. To neznamená, že rozpočet minut účtu nebo jiné limity funkcí jsou neomezené. |
data.quota.usage_percent |
integer | Zaokrouhlené procento kompatibilní s nástěnkou od 0 do 100: použité děleno (použité + zbývající), vynásobeno 100. Zahrnuje dostupnou kapacitu kreditu, takže dobíjení může procento snížit. Je 0 pro neomezený kvótu nebo nulovou velikost poolu; není to procento minutového limitu rychlosti ani rozhodnutí o přístupu. |
data.quota.reset_at |
string | Časové razítko ISO-8601 s posunem časového pásma pro další reset kvóty v kalendářním měsíci. Toto není datum vypršení předplatného a měsíční reset neobnovuje zakoupené kredity. |
status |
string | Doslovný úspěch pro tento stavový koncový bod. Ostatní úspěšné koncové body poštovní schránky používají boolean true. |
data.monthly_limit |
integer | Kompatibilní alias odpovídajícího pole data.quota; nepřidávejte jej znovu při výpočtu zůstatků. |
data.monthly_remaining |
integer|null | Kompatibilní alias odpovídajícího pole data.quota; nepřidávejte jej znovu při výpočtu zůstatků. |
data.purchased_credits |
integer | Kompatibilní alias odpovídajícího pole data.quota; nepřidávejte jej znovu při výpočtu zůstatků. |
Webhooky Mailbox (Reálný push v reálném čase)
Namísto opakovaného dotazování REST API (GET /messages) pro kontrolu příchozí pošty, nakonfigurujte Webhooky pro odesílání nových zpráv na váš server nebo automatizační workflow v reálném čase.
Podporované události Webhooků
Každý webhook může být předpsán na jeden nebo více typů událostí. Vaše koncové body přijímají oznámení události, když se spustí některý z těchto spouštěčů.
Odesláno v reálném čase, kdykoli nová zpráva dorazí do vybrané poštovní schránky.
Odesláno, když dojde k vypršení platnosti dočasné poštovní schránky a zpracování webhooku je pozastaveno.
Odesláno, když se po vypršení platnosti poštovní schránka opět aktivuje podle pravidel plánu.
Odesláno těsně před smazáním webhooku a jeho poštovní schránky.
Žádosti o hlavičky & ověření podpisu HMAC
Každá doručení webhooku obsahuje speciální bezpečnostní hlavičky. Použijte hlavičku X-TempMailg-Signature k ověření, že příchozí požadavky byly skutečně odeslány TempMailg a nebyly poškozeny.
| Název nadpisu | Příklad hodnoty | Popis |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Standardní identifikátor pro pracovníka doručování webhooku. |
X-TempMailg-Event |
email.received | Typ události, která spustila toto doručení. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | Jedinečný UUID přiřazený tomuto pokusu o doručení. |
X-TempMailg-Timestamp |
1725192000 | Unixový epochový časový razítko, které udává, kdy byl požadavek zahájen. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | HMAC-SHA256 podpis vypočítaný z {timestamp}.{raw_body} pomocí vašeho tajného klíče. |
X-TempMailg-Test |
false | Pravda, když je odesláno funkcí "Send Test Ping" ve vašem řídicím panelu. |
Podpis se počítá pomocí HMAC s SHA256 nad řetězcem:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Vzorkový payload události (email.received)
Poskytnuto jako aplikace/json v těle HTTP POST požadavku.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:17:46+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:46+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"
}
}
Příklady implementace přijímače
Vyberte svůj jazyk, abyste viděli, jak bezpečně přijímat webhooky a ověřovat HMAC podpisy.
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]);
Podporované platformy a integrace automatizace
Webhooky TempMailg fungují ihned s standardními HTTPS koncovými body a předními platformami bez kódu/automatizace:
Běžné chyby a řešení problémů
Tyto jsou nejčastější kódy odpovědí, které můžete vidět při integraci uživatelského API.
Neplatný, chybějící nebo odvolaný token Bearer.
Vlastnictví, oprávnění funkcí, přístup k doméně nebo velikost přílohy zabránily operaci. Zkontrolujte kód odpovědi a zprávu.
Zdroj nebyl nalezen na povoleném hostiteli nebo nepatří uživateli.
Klíč operace byl znovu použit s odlišnými podrobnostmi, další operace čeká, nebo se změnila bezpečnost poštovní schránky. Zkontrolujte kód před opakováním.
Schránka vypršela nebo je neaktivní.
Neplatné parametry, nepovolená životnost, nedostupná kapacita aliasu, neplatné nastavení PIN nebo chybějící/neplatný Idempotency-Key zabránily operaci.
Chráněná poštovní schránka vyžaduje platný token X-Mailbox-Unlock s omezeným rozsahem. Použijte pole action a target_id z odpovědi pro smazání. Požadavky na odblokování nebo obnovu musí být vyřešeny před dalším pokusem.
Limit požadavků, deaktivovaný plán, vyčerpaná kvóta nebo čekací doba zabránily operaci. Zkontrolujte důvod a hlavičky dostupného rozpočtu. Retry-After je volitelný.
Server nemohl dokončit operaci. Pro chráněné vytvoření nebo smazání zachovejte stejný požadavek a Idempotency-Key při opakování.
Uložení ochrany nebo koordinace nemohly být ověřeny. Opakujte po uvedeném zpoždění. Tato odpověď není neúspěšná platba.
Rychlý seznam
- 401 Unauthorized - Bearer token chybí, je špatný, zrušený nebo zkopírovaný nesprávně.
- 403 Forbidden - Aktuální plán nemá přístup k uživatelskému API právě teď.
- 404 Not Found - Zdroj nenalezen nebo neplatný parametr
- 410 Gone / Expired - Schránka vypršela nebo již není aktivní.
- 429 Rate Limited - Zkontrolujte důvod odpovědi a hlavičky rozpočtu. Retry-After se vztahuje pouze na časové limity; vyčerpání kreditů nebo zakázaný přístup může vyžadovat změnu účtu.
Doporučený další krok
Pokud jste přihlášeni, otevřete API Management nejdříve a potvrďte stav svého klíče, kvóty, přístupu k plánu a přesnou základní URL uživatelského API před laděním vaší externí aplikace.