Pikaisen asennuksen tarkistuslista
- Avaa dashboardin API-hallintasivu ja luo henkilökohtainen API-avain.
- Kopioi tarkka Käyttäjän API-perus-URL, joka näkyy siellä, esimerkiksi https://v1.tempmailg.com/api.
- Lähetä jokainen pyyntö tähän API-isäntään Authorization: Bearer YOUR_USER_API_KEY ja Accept: application/json.
- Seuraa kuukausittaista pyyntökiintiötäsi samalta hallintapaneelisivulta ja kiintiöotsikoista, kun ne ovat saatavilla käyttäjän API-vastauksissa. Vain onnistuneet 2xx-pyynnöt lasketaan kiintiöön.
API-avainkäyttö
Kirjaudu sisään luodaksesi henkilökohtaisen API-avaimen ja nähdäksesi live-kiintiötiedot.
Todennusvirta
- Luo henkilökohtainen API-avainsi dashboardin API-hallintasivulta.
- Lähetä avain Bearer-merkkinä jokaisessa pyynnössä.
- Käytä omistettua User API -perus-URL:ia, joka näkyy API-hallintasivullasi.
- Uudelleenluo avain aina, kun haluat mitätöidä vanhan ja käyttää uutta avainta välittömästi.
Vaaditut otsikot
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Nopeusrajoitus- ja kiintiöotsikot
Rate-limit-otsikot kuvaavat ilmoitettua pyyntöbudjettia. Kiintiö-otsikot sisällytetään, kun kiintiötiedot ovat saatavilla; minuutti-rajoituksen hylkäykset eivät laske täyttä kuukausittaista kiintiötäsi.
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— Suunnitelmallesi sallittu enimmäismäärä pyyntöjä minuutissa (RPM).X-RateLimit-Remaining— RPM-pyynnöt jäljellä nykyisessä minuutin ikkunassa.X-RateLimit-Reset— Unix-aikaleima, kun nykyisen minuutin nopeusrajan ikkuna nollautuu.X-Quota-Limit— Tilisi kokonaiskuukausittainen ja ostettu luottokapasiteetti.X-Quota-Remaining— Jäljellä olevat API-pyynnöt kuluvassa kuukaudessa.X-Quota-Used— API-pyyntöjen kokonaismäärä kulutettu nykyisen laskutuskauden aikana.X-Quota-Reset— ISO-8601 aikaleima, kun kuukausikvoottisi nollautuu.X-RateLimit-Scope— Budjetti, joka on kuvattu otsikoilla: account, ip, status_endpoint tai mailbox.X-Mailbox-RateLimit-*— Erillinen postilaatikon luonti/päivitysbudjetti. Onnistuneet postilaatikon vastaukset pitävät tilin RPM:n X-RateLimit-*; postilaatikkoon rajoittuva hylkäys käyttää postilaatikon laajuutta ja omaa uudelleenyritysikkunaa.Retry-After— Sekuntia ennen kuin ajoitettu uudelleenyritys on sopiva. Poistettu suunnitelma tai loppunut kiintiö saattaa vaatia tilin vaihtamista, joten tämä otsikko ei ole aina läsnä.503 protection_unavailable— API-suojauksen tallennus tai koordinointi on tilapäisesti poissa käytöstä. Yritä myöhemmin uudelleen; tämä ei ole maksun epäonnistuminen tai luoton veloitus.
Postilaatikon hallinta
Hae sallitut verkkotunnukset, luo tai vaihda postilaatikoita, valitse sallitut käyttöajat ja poista omistamasi osoitteet.
Listaa sallitut domainit
Listaa käytettävissä olevat domainit tilapäisten sähköpostien luomista varten. Suodata tyypin mukaan nähdäksesi vain tilauksesi tukemat ilmaiset, premium- tai mukautetut domainit.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
type
|
query | string | valinnainen |
Domain-tason suodatin. Jos jätetään pois, käytetään kaikkia, kun premium-domain -pääsy on käytössä, muuten ilmaisia. Tunnistetut arvot: free, basic, pro, premium, custom, ultimate, all
Oletus:
Tilistä riippuva
|
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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
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
}
]
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.requested_type |
string | Käytetty toimialuesuodatin. |
data.plan |
string | Nykyisen suunnitelman tunniste. |
data.plan_name |
string | Luettavissa oleva nykyisen suunnitelman nimi. |
data.allowed_types |
array<string> | Tälle tilille saatavilla olevat verkkotunnussuodattimet. Tunnistettu suodatin voi silti olla kielletty suunnitelmassasi. |
data.domains |
array | Valittavat domainit suodatuksen jälkeen; tyhjä taulukko on kelvollinen. |
data.domains[].domain |
string | Valittavissa oleva verkkotunnus. |
data.domains[].type |
string | Luettavissa oleva domain-tason etiketti. |
data.domains[].custom |
boolean | Onko kyseessä mukautettu verkkotunnus. |
Luo tilapäinen postilaatikko
Luo omistettu tilapäinen postilaatikko. Jätä käyttäjänimi ja domain pois satunnaista luontia varten, tai anna sallittu mukautettu käyttäjänimi ja sallittu domain. Provider-parametri voi valita Gmail- tai Outlook-aliaksen luomisen.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
username
|
body | string | valinnainen |
Valinnainen mukautettu käyttäjänimi: 2–64 ASCII-merkkiä, kirjaimia, numeroita, pisteitä, alaviivoja tai yhdysviivoja. Vaatii suunnitelmaluvan; custom_username on myös hyväksytty.
Oletus:
Satunnaisesti luotu
|
domain
|
body | string | valinnainen |
Yksi GET /domains -pyynnön palauttamista sallitusta verkkotunnuksesta. Jättäminen valitsee satunnaisen sallitun verkkotunnuksen.
Oletus:
Satunnainen sallittu verkkotunnus
|
lifetime
|
body | string | valinnainen |
sallitut arvot:
10m — 10 minuuttia
1h — 1 Tunti
2h — 2 tuntia
1d — 1 päivä
1w — 7 Päivää
1m — 30 päivää
3m — 90 päivää
6m — 180 päivää
1y — 365 päivää
unlimited — Rajaton
Oletus:
Suunnitelman oletusikä
|
provider
|
body | string | valinnainen |
Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias.
Oletus:
standard
|
pin_enabled
|
body | boolean | valinnainen |
Valinnainen PIN-suojaus uudelle postilaatikolle, jos suunnitelmasi sallii sen. Se ei muuta olemassa olevan postilaatikon PIN-koodia.
Oletus:
false
|
pin
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true: 6–8 numeron PIN, lähetetty merkkijonona säilyttääkseen etunollat.
|
pin_confirmation
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true. Täytyy täsmätä tarkalleen piniin.
|
Idempotency-Key
|
header | string | valinnainen |
Vaaditaan PIN-suojattuun luomiseen tai poistamiseen: vakaa 16–128 merkin avain. Toista identtinen pyyntö samalla avaimella välttääksesi kaksoistyön.
|
username (muokattu käyttäjänimi, jos suunnitelma sallii), domain (sallittu verkkotunnus, esim. example.com), lifetime (sallitut arvot: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Jätä elinikä pois tai jätä se tyhjäksi, jotta käytetään nykyisen kuukausi-/vuositilauksesi oletus‑sähköpostin elinikää. Lähetä sallittu elinikä, kuten 1h, korvataksesi oletuksen. Rajoittamatonta käytetään vain, kun se on määritetty tilauksen oletukseksi tai se on erikseen pyydetty ja sallittu. Runko-parametrit mailbox_lifetime ja email_lifetime hyväksytään myös; ensimmäinen ei-tyhjä arvo voittaa tässä järjestyksessä: lifetime, mailbox_lifetime, email_lifetime. Virheelliset tai kielletyt arvot palauttavat HTTP 422 sen sijaan, että hiljaisesti valittaisiin oletus.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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"data": {
"id": 2301,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-20T02:18:02+00:00",
"expires_in_seconds": 86399.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:02+00:00",
"email_token": "encrypted-email-token"
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.id |
integer | Postilaatikon ID. Luodut ID:t, osoitteet ja tokenit eroavat jokaisessa postilaatikossa. |
data.pin_protected |
boolean | Onko tällä postilaatikolla PIN-suojaus. PIN-koodia tai PIN-hashia ei palauteta. |
data.email |
string | Luotu täysi postilaatikon osoite. |
data.domain |
string | Luodun postilaatikon toimialue. |
data.provider |
string | Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias. |
data.expire_at |
string|null | Voimassa oleva päättymisaika ISO-8601-aikaleimana tai null, jos postilaatikko on rajoittamaton. |
data.expires_in_seconds |
number|null | Laskettuna jäljellä olevat ei‑negatiiviset sekunnit; murto‑sekunnit ovat mahdollisia. Null tarkoittaa rajoittamatonta, ei nollaa. |
data.mailbox_state |
string | Nykyinen postilaatikon tila: aktiivinen, keskeytetty, vanhentunut tai passiivinen. |
data.receiving_enabled |
boolean | Onko tämä postilaatikko tällä hetkellä vastaanottamassa saapuvia viestejä. |
data.message_count |
integer | Tunnettu kokonaisviestimäärä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.unread_message_count |
integer | Tunnettu lukemattomien viestien määrä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.last_message_received_at |
string|null | Viimeksi tunnettu vastaanotetun viestin aika ISO-8601-muodossa, tai null jos ei saatavilla. |
data.message_count_synced_at |
string|null | Viimeinen viestimäärän synkronointiaika ISO-8601-muodossa, tai null ennen synkronointia. |
data.created_at |
string|null | Postilaatikon luontiaika ISO-8601-muodossa. |
data.email_token |
string | Epäsuora salattu postilaatikon viite. Se ei korvaa Bearer-todennusta, omistajuustarkistuksia tai PIN-valtuutusta. |
data.pin_grant |
object | Ehdollinen: aktiivinen PIN-suojattu postilaatikon luominen palauttaa tämän lukuoikeuden; tavallinen suojaamaton luominen jättää sen pois. |
data.pin_grant.mailbox_id |
integer | Postilaatikon ID, johon ehdollinen lukuoikeus on sidottu. |
data.pin_grant.unlock_token |
string | Läpinäkymätön lukumerkki X-Mailbox-Unlock -toimintoa varten samalla omistajan tunnuksella. Pidä se yksityisenä ja muistissa; lukuoikeus ei valtuuta poistamista. |
data.pin_grant.scope |
string | Lukualue ehdolliselle luontiluvalle. |
data.pin_grant.idle_timeout_seconds |
integer | Sallittu odotusaika lukuoikeudelle, yleensä 3600 sekuntia. |
data.pin_grant.absolute_timeout_seconds |
integer | Lukuoikeuden enimmäiskesto, yleensä 86400 sekuntia. |
data.pin_grant.expires_at |
string | Nykyinen luku-oikeuden vanhentuminen ISO-8601-muodossa. |
data.pin_grant.absolute_expires_at |
string | Absoluuttinen lukuoikeuden vanhentumisaika ISO-8601-muodossa. Turvallisuusmuutokset voivat peruuttaa oikeuden aikaisemmin. |
Päivitä / Vaihda postilaatikko
Luo tai valitse postilaatikko uudessa käyttäjänimessä ja domainissa sen jälkeen, kun nykyisen postilaatikon omistajuus on vahvistettu. Tämä ei nimeä vanhaa postilaatikkoa uudelleen eikä muuta sen käyttöikää paikallisesti. Kun kohde eroaa, vanha postilaatikko säilyy historiassa ja se saattaa pysäyttää aktiivisen postilaatikon rajoitukset. Oman aktiivisen kohteen uudelleenkäyttö asettaa sen pyydetyn käyttöiän tai suunnitelman oletuksen uudelleen.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
email
|
path | string | pakollinen |
Omistetun postilaatikon nykyinen täysi sähköpostiosoite vaihdettavaksi. URL-koodaa jokainen polun osa; koodaa plus-merkki %2B.
|
username
|
path | string | pakollinen |
Uusi haluttu käyttäjänimi: 2-64 alfanumeerista merkkiä; edellyttää mukautettua käyttäjänimen lupaa.
|
domain
|
path | string | pakollinen |
Uusi sallittu verkkotunnus.
|
lifetime
|
body | string | valinnainen |
sallitut arvot:
10m — 10 minuuttia
1h — 1 Tunti
2h — 2 tuntia
1d — 1 päivä
1w — 7 Päivää
1m — 30 päivää
3m — 90 päivää
6m — 180 päivää
1y — 365 päivää
unlimited — Rajaton
Oletus:
Suunnitelman oletusikä
|
pin_enabled
|
body | boolean | valinnainen |
Valinnainen PIN-suojaus uudelle postilaatikolle, jos suunnitelmasi sallii sen. Se ei muuta olemassa olevan postilaatikon PIN-koodia.
Oletus:
false
|
pin
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true: 6–8 numeron PIN, lähetetty merkkijonona säilyttääkseen etunollat.
|
pin_confirmation
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true. Täytyy täsmätä tarkalleen piniin.
|
Idempotency-Key
|
header | string | valinnainen |
Vaaditaan PIN-suojattuun luomiseen tai poistamiseen: vakaa 16–128 merkin avain. Toista identtinen pyyntö samalla avaimella välttääksesi kaksoistyön.
|
X-Mailbox-Unlock
|
header | string | valinnainen |
Otsikko, vain suojatut postilaatikot: käytä luku-unlock_tokenia. Lähetä ensin POST pin ja scope=read PIN-unlock-URLiin. Säilytä normaali Bearer-todennus. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (sallitut arvot: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Jätä elinikä pois tai jätä se tyhjäksi, jotta käytetään nykyisen kuukausi-/vuositilauksesi oletus‑sähköpostin elinikää. Lähetä sallittu elinikä, kuten 1h, korvataksesi oletuksen. Rajoittamatonta käytetään vain, kun se on määritetty tilauksen oletukseksi tai se on erikseen pyydetty ja sallittu. Runko-parametrit mailbox_lifetime ja email_lifetime hyväksytään myös; ensimmäinen ei-tyhjä arvo voittaa tässä järjestyksessä: lifetime, mailbox_lifetime, email_lifetime. Virheelliset tai kielletyt arvot palauttavat HTTP 422 sen sijaan, että hiljaisesti valittaisiin oletus.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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"data": {
"id": 2302,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-19T02:28:02+00:00",
"expires_in_seconds": 599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:02+00:00",
"email_token": "encrypted-email-token"
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.id |
integer | Postilaatikon ID. Luodut ID:t, osoitteet ja tokenit eroavat jokaisessa postilaatikossa. |
data.pin_protected |
boolean | Onko tällä postilaatikolla PIN-suojaus. PIN-koodia tai PIN-hashia ei palauteta. |
data.email |
string | Luotu täysi postilaatikon osoite. |
data.domain |
string | Luodun postilaatikon toimialue. |
data.provider |
string | Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias. |
data.expire_at |
string|null | Voimassa oleva päättymisaika ISO-8601-aikaleimana tai null, jos postilaatikko on rajoittamaton. |
data.expires_in_seconds |
number|null | Laskettuna jäljellä olevat ei‑negatiiviset sekunnit; murto‑sekunnit ovat mahdollisia. Null tarkoittaa rajoittamatonta, ei nollaa. |
data.mailbox_state |
string | Nykyinen postilaatikon tila: aktiivinen, keskeytetty, vanhentunut tai passiivinen. |
data.receiving_enabled |
boolean | Onko tämä postilaatikko tällä hetkellä vastaanottamassa saapuvia viestejä. |
data.message_count |
integer | Tunnettu kokonaisviestimäärä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.unread_message_count |
integer | Tunnettu lukemattomien viestien määrä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.last_message_received_at |
string|null | Viimeksi tunnettu vastaanotetun viestin aika ISO-8601-muodossa, tai null jos ei saatavilla. |
data.message_count_synced_at |
string|null | Viimeinen viestimäärän synkronointiaika ISO-8601-muodossa, tai null ennen synkronointia. |
data.created_at |
string|null | Postilaatikon luontiaika ISO-8601-muodossa. |
data.email_token |
string | Epäsuora salattu postilaatikon viite. Se ei korvaa Bearer-todennusta, omistajuustarkistuksia tai PIN-valtuutusta. |
data.pin_grant |
object | Ehdollinen: aktiivinen PIN-suojattu postilaatikon luominen palauttaa tämän lukuoikeuden; tavallinen suojaamaton luominen jättää sen pois. |
data.pin_grant.mailbox_id |
integer | Postilaatikon ID, johon ehdollinen lukuoikeus on sidottu. |
data.pin_grant.unlock_token |
string | Läpinäkymätön lukumerkki X-Mailbox-Unlock -toimintoa varten samalla omistajan tunnuksella. Pidä se yksityisenä ja muistissa; lukuoikeus ei valtuuta poistamista. |
data.pin_grant.scope |
string | Lukualue ehdolliselle luontiluvalle. |
data.pin_grant.idle_timeout_seconds |
integer | Sallittu odotusaika lukuoikeudelle, yleensä 3600 sekuntia. |
data.pin_grant.absolute_timeout_seconds |
integer | Lukuoikeuden enimmäiskesto, yleensä 86400 sekuntia. |
data.pin_grant.expires_at |
string | Nykyinen luku-oikeuden vanhentuminen ISO-8601-muodossa. |
data.pin_grant.absolute_expires_at |
string | Absoluuttinen lukuoikeuden vanhentumisaika ISO-8601-muodossa. Turvallisuusmuutokset voivat peruuttaa oikeuden aikaisemmin. |
Poista postilaatikko
Poista omistettu postilaatikko ja käynnistä sen viestien ja tiedostojen puhdistus. Säilytetyt postilaatikkotiedot voidaan poistaa pehmeästi sisäisesti; osoite ei ole enää käytettävissä API:n kautta.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
email
|
path | string | pakollinen |
Poistettavan omistetun postilaatikon koko sähköpostiosoite. URL-koodaa osoite; koodaa plus-merkki muodossa %2B.
|
X-Mailbox-Unlock
|
header | string | valinnainen |
Otsikko, vain suojatut postilaatikot: käytä kertakäyttöistä poistotunnusta unlock_token. Ensin POST pin, scope=delete ja action/target_id, jonka 423 response palauttaa PIN unlock URL:iin. Luku‑token ei voi poistaa. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | valinnainen |
Vaaditaan PIN-suojattuun luomiseen tai poistamiseen: vakaa 16–128 merkin avain. Toista identtinen pyyntö samalla avaimella välttääksesi kaksoistyön.
|
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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
message |
string | Poistamisen tulos. Puuttuva resurssi palauttaa HTTP 404. |
Gmail & Outlook Aliakset
Luo korkean maineen Gmail- ja Outlook/Hotmail-aliaskäyttäjätiloja.
Luo Gmail-aliaksen
Luo uusi Gmail-aliaksen tilapäinen postilaatikko, jonka omistaja on todennettu käyttäjä.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
mode
|
body | string | valinnainen |
Luontitila: auto, dot, plus tai plus_dot. Hyväksyy myös gmail_alias_mode. Jos tyylin valinta ei ole sallittu, käytetään autoa.
Oletus:
auto
|
username
|
body | string | valinnainen |
Valinnainen mukautettu alias-pääte: 2–32 ASCII-merkkiä tai numeroa, normalisoitu pieniksi kirjaimiksi; edellyttää ominaisuuden lupaa. Hyväksyy myös custom_username tai alias_username.
Oletus:
Automaattisesti luotu
|
domain
|
body | string | valinnainen |
Käytä satunnaista, gmail.com tai googlemail.com; alias_domain on myös hyväksytty. Jos jätetään pois tai domain‑valintaoikeus ei ole saatavilla, käytetään satunnaista.
Oletus:
random
|
lifetime
|
body | string | valinnainen |
sallitut arvot:
10m — 10 minuuttia
1h — 1 Tunti
2h — 2 tuntia
1d — 1 päivä
1w — 7 Päivää
1m — 30 päivää
3m — 90 päivää
6m — 180 päivää
1y — 365 päivää
unlimited — Rajaton
Oletus:
Suunnitelman oletusikä
|
pin_enabled
|
body | boolean | valinnainen |
Valinnainen PIN-suojaus uudelle postilaatikolle, jos suunnitelmasi sallii sen. Se ei muuta olemassa olevan postilaatikon PIN-koodia.
Oletus:
false
|
pin
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true: 6–8 numeron PIN, lähetetty merkkijonona säilyttääkseen etunollat.
|
pin_confirmation
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true. Täytyy täsmätä tarkalleen piniin.
|
Idempotency-Key
|
header | string | valinnainen |
Vaaditaan PIN-suojattuun luomiseen tai poistamiseen: vakaa 16–128 merkin avain. Toista identtinen pyyntö samalla avaimella välttääksesi kaksoistyön.
|
mode (auto, dot, plus, plus_dot), username (muokattu alias-käyttäjänimi), domain (esim. gmail.com, googlemail.com), lifetime (sallitut arvot: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Jätä elinikä pois tai jätä se tyhjäksi, jotta käytetään nykyisen kuukausi-/vuositilauksesi oletus‑sähköpostin elinikää. Lähetä sallittu elinikä, kuten 1h, korvataksesi oletuksen. Rajoittamatonta käytetään vain, kun se on määritetty tilauksen oletukseksi tai se on erikseen pyydetty ja sallittu. Runko-parametrit mailbox_lifetime ja email_lifetime hyväksytään myös; ensimmäinen ei-tyhjä arvo voittaa tässä järjestyksessä: lifetime, mailbox_lifetime, email_lifetime. Virheelliset tai kielletyt arvot palauttavat HTTP 422 sen sijaan, että hiljaisesti valittaisiin oletus.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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"data": {
"id": 2305,
"pin_protected": false,
"email": "example+alias123@gmail.com",
"domain": "gmail.com",
"provider": "gmail_alias",
"expire_at": "2026-11-19T03:18:02+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:02+00:00",
"email_token": "encrypted-email-token"
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.id |
integer | Postilaatikon ID. Luodut ID:t, osoitteet ja tokenit eroavat jokaisessa postilaatikossa. |
data.pin_protected |
boolean | Onko tällä postilaatikolla PIN-suojaus. PIN-koodia tai PIN-hashia ei palauteta. |
data.email |
string | Luotu täysi postilaatikon osoite. |
data.domain |
string | Luodun postilaatikon toimialue. |
data.provider |
string | Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias. |
data.expire_at |
string|null | Voimassa oleva päättymisaika ISO-8601-aikaleimana tai null, jos postilaatikko on rajoittamaton. |
data.expires_in_seconds |
number|null | Laskettuna jäljellä olevat ei‑negatiiviset sekunnit; murto‑sekunnit ovat mahdollisia. Null tarkoittaa rajoittamatonta, ei nollaa. |
data.mailbox_state |
string | Nykyinen postilaatikon tila: aktiivinen, keskeytetty, vanhentunut tai passiivinen. |
data.receiving_enabled |
boolean | Onko tämä postilaatikko tällä hetkellä vastaanottamassa saapuvia viestejä. |
data.message_count |
integer | Tunnettu kokonaisviestimäärä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.unread_message_count |
integer | Tunnettu lukemattomien viestien määrä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.last_message_received_at |
string|null | Viimeksi tunnettu vastaanotetun viestin aika ISO-8601-muodossa, tai null jos ei saatavilla. |
data.message_count_synced_at |
string|null | Viimeinen viestimäärän synkronointiaika ISO-8601-muodossa, tai null ennen synkronointia. |
data.created_at |
string|null | Postilaatikon luontiaika ISO-8601-muodossa. |
data.email_token |
string | Epäsuora salattu postilaatikon viite. Se ei korvaa Bearer-todennusta, omistajuustarkistuksia tai PIN-valtuutusta. |
data.pin_grant |
object | Ehdollinen: aktiivinen PIN-suojattu postilaatikon luominen palauttaa tämän lukuoikeuden; tavallinen suojaamaton luominen jättää sen pois. |
data.pin_grant.mailbox_id |
integer | Postilaatikon ID, johon ehdollinen lukuoikeus on sidottu. |
data.pin_grant.unlock_token |
string | Läpinäkymätön lukumerkki X-Mailbox-Unlock -toimintoa varten samalla omistajan tunnuksella. Pidä se yksityisenä ja muistissa; lukuoikeus ei valtuuta poistamista. |
data.pin_grant.scope |
string | Lukualue ehdolliselle luontiluvalle. |
data.pin_grant.idle_timeout_seconds |
integer | Sallittu odotusaika lukuoikeudelle, yleensä 3600 sekuntia. |
data.pin_grant.absolute_timeout_seconds |
integer | Lukuoikeuden enimmäiskesto, yleensä 86400 sekuntia. |
data.pin_grant.expires_at |
string | Nykyinen luku-oikeuden vanhentuminen ISO-8601-muodossa. |
data.pin_grant.absolute_expires_at |
string | Absoluuttinen lukuoikeuden vanhentumisaika ISO-8601-muodossa. Turvallisuusmuutokset voivat peruuttaa oikeuden aikaisemmin. |
Outlookin alias-alueet
Hae aktiiviset Outlook / Hotmail aliaksen verkkotunnukset, jotka ovat käytettävissä postilaatikon luomiseen.
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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
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
}
]
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.domains |
array | Aktiiviset Outlook/Hotmail-verkkotunnukset; tyhjä taulukko on kelvollinen. |
data.domains[].domain |
string | Saatavilla oleva verkkotunnus. |
data.domains[].type |
string | Luettavissa oleva tarjoajan tunniste. |
data.domains[].selectable |
boolean | Voiko tilisi valita tämän domainin nimenomaisesti. |
data.domains[].locked |
boolean | Onko eksplisiittinen domain‑valinta lukittu tilillesi. |
data.domains[].disabled_reason |
string|null | Syy, miksi verkkotunnuksen valinta on lukittu, tai null, kun se on valittavissa. |
Luo Outlook-aliaksen
Luo uusi Outlook / Hotmail -alias, tilapäinen postilaatikko, jonka omistajana on todennettu käyttäjä.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
domain
|
body | string | valinnainen |
Käytä satunnaista tai verkkotunnusta GET /outlook-alias/domains; outlook_alias_domain on myös hyväksytty. Ilman valintaoikeutta käytetään satunnaista.
Oletus:
Satunnainen käytettävissä oleva domain
|
username
|
body | string | valinnainen |
Valinnainen mukautettu alias-pääte: 2–32 ASCII-merkkiä tai numeroa, normalisoitu pieniksi kirjaimiksi; edellyttää ominaisuuden lupaa. Hyväksyy myös custom_username tai alias_username.
Oletus:
Automaattisesti luotu
|
lifetime
|
body | string | valinnainen |
sallitut arvot:
10m — 10 minuuttia
1h — 1 Tunti
2h — 2 tuntia
1d — 1 päivä
1w — 7 Päivää
1m — 30 päivää
3m — 90 päivää
6m — 180 päivää
1y — 365 päivää
unlimited — Rajaton
Oletus:
Suunnitelman oletusikä
|
pin_enabled
|
body | boolean | valinnainen |
Valinnainen PIN-suojaus uudelle postilaatikolle, jos suunnitelmasi sallii sen. Se ei muuta olemassa olevan postilaatikon PIN-koodia.
Oletus:
false
|
pin
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true: 6–8 numeron PIN, lähetetty merkkijonona säilyttääkseen etunollat.
|
pin_confirmation
|
body | string | valinnainen |
Vaaditaan, kun pin_enabled on true. Täytyy täsmätä tarkalleen piniin.
|
Idempotency-Key
|
header | string | valinnainen |
Vaaditaan PIN-suojattuun luomiseen tai poistamiseen: vakaa 16–128 merkin avain. Toista identtinen pyyntö samalla avaimella välttääksesi kaksoistyön.
|
domain (esim. outlook.com, hotmail.com), username (muokattu alias-käyttäjänimi), lifetime (sallitut arvot: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Jätä elinikä pois tai jätä se tyhjäksi, jotta käytetään nykyisen kuukausi-/vuositilauksesi oletus‑sähköpostin elinikää. Lähetä sallittu elinikä, kuten 1h, korvataksesi oletuksen. Rajoittamatonta käytetään vain, kun se on määritetty tilauksen oletukseksi tai se on erikseen pyydetty ja sallittu. Runko-parametrit mailbox_lifetime ja email_lifetime hyväksytään myös; ensimmäinen ei-tyhjä arvo voittaa tässä järjestyksessä: lifetime, mailbox_lifetime, email_lifetime. Virheelliset tai kielletyt arvot palauttavat HTTP 422 sen sijaan, että hiljaisesti valittaisiin oletus.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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"data": {
"id": 2306,
"pin_protected": false,
"email": "example+alias45@outlook.com",
"domain": "outlook.com",
"provider": "outlook_alias",
"expire_at": "2026-11-19T03:18:02+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:02+00:00",
"email_token": "encrypted-email-token"
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.id |
integer | Postilaatikon ID. Luodut ID:t, osoitteet ja tokenit eroavat jokaisessa postilaatikossa. |
data.pin_protected |
boolean | Onko tällä postilaatikolla PIN-suojaus. PIN-koodia tai PIN-hashia ei palauteta. |
data.email |
string | Luotu täysi postilaatikon osoite. |
data.domain |
string | Luodun postilaatikon toimialue. |
data.provider |
string | Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias. |
data.expire_at |
string|null | Voimassa oleva päättymisaika ISO-8601-aikaleimana tai null, jos postilaatikko on rajoittamaton. |
data.expires_in_seconds |
number|null | Laskettuna jäljellä olevat ei‑negatiiviset sekunnit; murto‑sekunnit ovat mahdollisia. Null tarkoittaa rajoittamatonta, ei nollaa. |
data.mailbox_state |
string | Nykyinen postilaatikon tila: aktiivinen, keskeytetty, vanhentunut tai passiivinen. |
data.receiving_enabled |
boolean | Onko tämä postilaatikko tällä hetkellä vastaanottamassa saapuvia viestejä. |
data.message_count |
integer | Tunnettu kokonaisviestimäärä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.unread_message_count |
integer | Tunnettu lukemattomien viestien määrä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
data.last_message_received_at |
string|null | Viimeksi tunnettu vastaanotetun viestin aika ISO-8601-muodossa, tai null jos ei saatavilla. |
data.message_count_synced_at |
string|null | Viimeinen viestimäärän synkronointiaika ISO-8601-muodossa, tai null ennen synkronointia. |
data.created_at |
string|null | Postilaatikon luontiaika ISO-8601-muodossa. |
data.email_token |
string | Epäsuora salattu postilaatikon viite. Se ei korvaa Bearer-todennusta, omistajuustarkistuksia tai PIN-valtuutusta. |
data.pin_grant |
object | Ehdollinen: aktiivinen PIN-suojattu postilaatikon luominen palauttaa tämän lukuoikeuden; tavallinen suojaamaton luominen jättää sen pois. |
data.pin_grant.mailbox_id |
integer | Postilaatikon ID, johon ehdollinen lukuoikeus on sidottu. |
data.pin_grant.unlock_token |
string | Läpinäkymätön lukumerkki X-Mailbox-Unlock -toimintoa varten samalla omistajan tunnuksella. Pidä se yksityisenä ja muistissa; lukuoikeus ei valtuuta poistamista. |
data.pin_grant.scope |
string | Lukualue ehdolliselle luontiluvalle. |
data.pin_grant.idle_timeout_seconds |
integer | Sallittu odotusaika lukuoikeudelle, yleensä 3600 sekuntia. |
data.pin_grant.absolute_timeout_seconds |
integer | Lukuoikeuden enimmäiskesto, yleensä 86400 sekuntia. |
data.pin_grant.expires_at |
string | Nykyinen luku-oikeuden vanhentuminen ISO-8601-muodossa. |
data.pin_grant.absolute_expires_at |
string | Absoluuttinen lukuoikeuden vanhentumisaika ISO-8601-muodossa. Turvallisuusmuutokset voivat peruuttaa oikeuden aikaisemmin. |
Viestit ja liitteet
Nouda saapuvat postilaatikot, lue täysi HTML-/tekstiviestit ja suoratoista liitteet.
Listaa postilaatikon viestit
Hae käytettävissä olevat viestitiivistelmät ja postilaatikon metadata. Standardi postilaatikon skannaukset palauttavat viimeisimmän erän, jossa on enintään 25 viestiä; tämä ei ole sivutettu koko historian päätepiste. Käytä GET /messages/{messageId} saadaksesi täyden sisällön ja liitteet.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
email
|
query | string | pakollinen |
Omistetun postilaatikon täydellinen sähköpostiosoite, josta viestejä luetaan. URL-koodaa kyselyarvo; koodaa plus-merkki %2B.
|
X-Mailbox-Unlock
|
header | string | valinnainen |
Otsikko, vain suojatut postilaatikot: käytä luku-unlock_tokenia. Lähetä ensin POST pin ja scope=read PIN-unlock-URLiin. Säilytä normaali Bearer-todennus. <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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"mailbox": "demo123@example.com",
"email_token": "encrypted-email-token",
"messages": [
{
"is_seen": false,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"receivedAt": "2026-11-19 02:18:02",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"otp": null,
"otp_locked": false,
"verification_link": null,
"verification_link_locked": false
}
],
"mailbox_provider": "standard",
"mailbox_state": "active",
"expire_at": "2026-11-20T02:18:02+00:00",
"expires_in_seconds": 86399.75,
"receiving_enabled": true,
"mailbox_limit": {
"limit": 50,
"limit_label": "50",
"active_count": 1,
"paused_count": 0,
"paused_mailboxes": [],
"remaining": 49,
"remaining_label": "49",
"reached": false,
"blocked": false,
"provider": "standard"
},
"message_count": 1,
"unread_message_count": 1,
"last_message_received_at": "2026-11-19T02:18:02+00:00",
"message_count_synced_at": "2026-11-19T02:18:02+00:00"
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
mailbox |
string | Postilaatikon osoite, jonka viestejä pyydettiin. |
email_token |
string | Läpinäkymätön salattu postilaatikkoviite; normaali todennus on edelleen vaadittu. |
mailbox_provider |
string | Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias. |
messages |
array | Viestiyhteenvedot. Tyhjä postilaatikko palauttaa tyhjän taulukon; hae yksi viesti sen sisällön ja liitteiden saamiseksi. |
expire_at |
string|null | Voimassa oleva päättymisaika ISO-8601-aikaleimana tai null, jos postilaatikko on rajoittamaton. |
expires_in_seconds |
number|null | Laskettuna jäljellä olevat ei‑negatiiviset sekunnit; murto‑sekunnit ovat mahdollisia. Null tarkoittaa rajoittamatonta, ei nollaa. |
mailbox_state |
string | Nykyinen postilaatikon tila: aktiivinen, keskeytetty, vanhentunut tai passiivinen. |
receiving_enabled |
boolean | Onko tämä postilaatikko tällä hetkellä vastaanottamassa saapuvia viestejä. |
message_count |
integer | Tunnettu kokonaisviestimäärä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
unread_message_count |
integer | Tunnettu lukemattomien viestien määrä; se voi heijastaa viimeisintä postilaatikon synkronointia. |
last_message_received_at |
string|null | Viimeksi tunnettu vastaanotetun viestin aika ISO-8601-muodossa, tai null jos ei saatavilla. |
message_count_synced_at |
string|null | Viimeinen viestimäärän synkronointiaika ISO-8601-muodossa, tai null ennen synkronointia. |
mailbox_limit.limit |
integer | Tämän palveluntarjoajan aktiivinen postilaatikkoraja; -1 tarkoittaa rajoittamatonta. |
mailbox_limit.limit_label |
string | Näyttötunniste postilaatinon rajoitukselle. |
mailbox_limit.active_count |
integer | Tämän tarjoajan aktiivisten postilaatikoiden määrä. |
mailbox_limit.paused_count |
integer | Tämän tarjoajan tauotettujen postilaatikoiden määrä. |
mailbox_limit.paused_mailboxes |
array<string> | Osoitteet on keskeytetty postilaatikon rajan vuoksi. |
mailbox_limit.remaining |
integer | Jäljellä olevat aktiiviset postilaatikkopaikat; -1 tarkoittaa rajoittamatonta. Tämä ei ole API-pyyntöjen kiintiö. |
mailbox_limit.remaining_label |
string | Näytä merkintä jäljellä olevista postilaatikon paikoista. |
mailbox_limit.reached |
boolean | Onko aktiivinen postilaatikkoraja saavutettu. |
mailbox_limit.blocked |
boolean | Onko aktiivinen postilaatin raja nolla. |
mailbox_limit.provider |
string|null | Palveluntarjoaja, johon postilaatikon raja kohdistuu. |
messages[].id |
string | Epäsuora viestitunnus, jota käytetään yksittäisen viestin, poistamisen ja liitteen päätepisteissä. |
messages[].is_seen |
boolean | Onko viesti merkitty luetuksi. |
messages[].subject |
string | Viestin aihe. |
messages[].from |
string | Lähettäjän näyttönimi tai osoite. |
messages[].from_email |
string | Lähettäjän sähköpostiosoite. |
messages[].receivedAt |
string | Vastaanottoaika sovelluksen aikavyöhykkeessä, muotoiltu muodossa YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Havaittu kertakäyttökoodi, kun se on saatavilla ja sallittu; muuten null. |
messages[].otp_locked |
boolean | Onko havaittu kertakäyttökoodi piilotettu ominaisuuksien käyttöoikeuksilla. |
messages[].verification_link |
string|null | Havaittu vahvistus-URL, kun se on saatavilla ja sallittu; muuten null. |
messages[].verification_link_locked |
boolean | Onko havaittu vahvistuslinkki piilotettu ominaisuuksien käyttöoikeuksilla. |
messages[].from_name |
string|null | Outlook-yhteenvedon kenttä: alkuperäisen lähettäjän nimi. Puuttuu Standard- ja Gmail-yhteenvedosta. |
messages[].snippet |
string|null | Outlook-yhteenvedon kenttä: lyhyt viestin esikatselu. |
messages[].received_at |
string|null | Outlook-yhteenvedon kenttä: ISO-8601 vastaanottoaika, kun tiedossa. |
messages[].has_attachments |
boolean | Outlookin yhteenvetokenttä: onko liitetiedoston metatiedot olemassa. Latauksen saatavuus tarkistetaan erikseen. |
Hae yksittäinen viesti
Hae omistettu viesti sen epäsuoralla viesti-ID:llä. Palauttaa rungon muodot ja liitteiden metatiedot. Rungon kentät riippuvat viestin muodosta; Outlook lisää alla luetellut toimittajakohtaiset kentät.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
messageId
|
path | string | pakollinen |
Ainutlaatuinen viestin tunniste, joka palautetaan viestilistassa.
|
X-Mailbox-Unlock
|
header | string | valinnainen |
Otsikko, vain suojatut postilaatikot: käytä luku-unlock_tokenia. Lähetä ensin POST pin ja scope=read PIN-unlock-URLiin. Säilytä normaali Bearer-todennus. <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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"data": {
"is_seen": true,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"to": "demo123@example.com",
"mailbox_provider": "standard",
"receivedAt": "2026-11-19 02:18:02",
"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"
}
]
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
data.id |
string | Epäsuora viestin ID. |
data.is_seen |
boolean | Viestin luetun tila. Lukeminen voi merkitä sen nähdyksi; välimuistissa oleva data voi heijastaa aikaisempaa tilaa. |
data.subject |
string | Viestin aihe. |
data.from |
string | Lähettäjän näyttönimi tai osoite. |
data.from_email |
string | Lähettäjän sähköpostiosoite. |
data.to |
string | Vastaanottajan postilaatikon osoite. |
data.mailbox_provider |
string | Postilaatikon tarjoaja: standard, gmail_alias tai outlook_alias. |
data.receivedAt |
string | Vastaanottoaika sovelluksen aikavyöhykkeessä, muotoiltu muodossa YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Onko viestissä HTML-runko. |
data.html_content |
string | HTML-runko, kun se on läsnä. Tavalliset viestit ilman HTML:ää voivat jättää tämän kentän pois. Käsittele viestin sisältöä epäluotettavana. |
data.text_content |
string | Tekstirunko, jos se on läsnä; Vakioviestit saattavat sisältää pakatun tekstin pre-elementissä tai jättää tämän kentän pois. |
data.content |
string | Ensisijainen sisältö näytettäväksi, yleensä HTML kun saatavilla. |
data.attachments |
array | Liitteen metatiedot tai tyhjä taulukko. Lataukset vaativat normaalin todennuksen ja soveltuvan PIN‑valtuutuksen. |
data.attachments[].name |
string | Tiedostonimi URL-koodattavaksi yhtenä polkuosana ladattaessa. |
data.attachments[].size |
integer | Liitteen koko tavuina. |
data.attachments[].url |
string | Todennettu käyttäjän API:n lataus-URL lisätty liitteisiin tiedostonimellä. URL ei takaa, että paikallinen tiedosto on saatavilla. |
data.attachments[].extension |
string | Standardi/Gmail-metatietokenttä: tiedostopääte, jos annettu. |
data.attachments[].id |
string | Outlookin metatietokenttä: palveluntarjoajan liitetunnus. |
data.attachments[].content_type |
string | Outlookin metatietokenttä: MIME-sisältötyyppi. |
data.from_name |
string|null | Outlookin yksityiskohtakenttä: alkuperäisen lähettäjän nimi. |
data.to_email |
string|null | Outlookin yksityiskenttä: alkuperäisen vastaanottajan osoite. |
data.received_at |
string|null | Outlookin yksityiskenttä: ISO-8601 vastaanottoaika. |
data.has_html |
boolean | Outlookin yksityiskenttä: onko HTML-runko olemassa. |
Poista viesti
Poista yksi omistettu viesti
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
messageId
|
path | string | pakollinen |
Ainutlaatuinen viestin ID-merkkijono pysyvästi poistettavaksi.
|
X-Mailbox-Unlock
|
header | string | valinnainen |
Otsikko, vain suojatut postilaatikot: käytä kertakäyttöistä poistotunnusta unlock_token. Ensin POST pin, scope=delete ja action/target_id, jonka 423 response palauttaa PIN unlock URL:iin. Luku‑token ei voi poistaa. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | valinnainen |
Vaaditaan PIN-suojattuun luomiseen tai poistamiseen: vakaa 16–128 merkin avain. Toista identtinen pyyntö samalla avaimella välttääksesi kaksoistyön.
|
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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status |
boolean | Onko operaatio onnistunut. |
message |
string | Poistamisen tulos. Puuttuva resurssi palauttaa HTTP 404. |
Lataa liite
Lataa liite omistetusta viestistä.
| Parametri | Sijainti | Tyyppi | Tila | Kuvaus |
|---|---|---|---|---|
messageId
|
path | string | pakollinen |
Tiedoston sisältävän viestin ID.
|
filename
|
path | string | pakollinen |
Liitetiedoston tiedostonimi ja tiedostopääte ladattavaksi.
|
X-Mailbox-Unlock
|
header | string | valinnainen |
Otsikko, vain suojatut postilaatikot: käytä luku-unlock_tokenia. Lähetä ensin POST pin ja scope=read PIN-unlock-URLiin. Säilytä normaali Bearer-todennus. <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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
Content-Disposition |
header | Onnistunut vastaus lataa pyydetyn tiedostonimen. |
body |
binary | Tiedoston tavut onnistumisessa, ei JSON. Virheet palauttavat JSON:n, jossa on ei-2xx-tila. |
Ratelimitit & Kiintiöt
Seuraa reaaliaikaisia pyyntöbudjetteja, nopeusrajoituksia ja tilin kiintiöitä kuluttamatta krediittejä.
Nopeusrajoitus ja kiintiö
Tarkista nykyinen nopeusraja ja kiintiön tila kuluttamatta API-käyttöä. Tämä päätepiste on kiintiötön eikä vähennä kuukausittaisia API-kynttejä (käytön väärinkäytön suojausraja: 60 pyyntöä/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'
Kuvitteellinen vastaus käyttäen synteettisiä tietoja. ID:t, osoitteet, tokenit, aikaleimat, suunnitelman rajoitukset ja määrät vaihtelevat. Esimerkkielinikä ei korvaa suunnitelmasi oletusta. Vastauskenttien kuvaukset tunnistavat null-arvot ja toimittajakohtaiset kentät.
Esimerkki vastaus
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"
}
}
}
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
data.limit |
integer|string | Tilin pyyntöjen per minuutti -raja. Merkkijono unlimited tarkoittaa rajoittamatonta minuutin budjettia; tämä on riippumaton kuukausittaisesta kiintiöstä. |
data.remaining |
integer|string | Jäljellä olevat tilin minuuttibudjetin paikat, tai merkkijono unlimited. Positiivinen arvo ei tarkoita, että API‑krediittejä on jäljellä. |
data.reset |
integer | Sekunnit tilin minuutti-ikkunalle, ei kuukausittaisen kiintiön nollaukselle. Poistettu tai rajoittamaton minuuttibudjetti voi säilyttää nimellisesti 60 sekunnin arvon; tämä ei takaa pääsyä odottamisen jälkeen. |
data.plan |
string | Nykyinen suunnitelmatunniste. Luettavissa oleva suunnitelman nimi annetaan erikseen kohteessa data.quota.plan_name. |
data.quota.enabled |
boolean | Onko globaali ja suunnitelma/luotto-API-pääsy käytössä. Tämä ei kerro jäljellä olevaa kapasiteettia eikä korvaa käyttäjän API-kytkintä. |
data.quota.user_api_status |
boolean | Onko käyttäjä ottanut käyttöön User API -kytkimen. Toiminnot vaativat tämän kytkimen sekä käytössä olevan pääsyn ja saatavilla olevan kapasiteetin. |
data.quota.plan_name |
string | Luettavissa oleva nykyisen suunnitelman nimi. |
data.quota.period |
string | Kalenterikuukauden käyttöjakso YYYY-MM -muodossa, käyttäen sovelluksen aikavyöhykettä; ei välttämättä tilauksen laskutusjaksoa. |
data.quota.base_limit |
integer | Peruskuukausittainen suunnitelman sallittu määrä. Arvo -1 tarkoittaa rajoittamatonta. |
data.quota.extra_requests |
integer | Lisäkuukausittainen kiintiö myönnetty nykyiselle käyttökaudelle; erillinen ostetuista krediiteistä. |
data.quota.monthly_limit |
integer | Peruskiintiö plus nykyisen kauden lisäpyynnöt. Arvo -1 tarkoittaa rajoittamatonta. Ostetut krediitit eivät sisälly. |
data.quota.monthly_remaining |
integer|null | Jäljellä oleva rajoitettu kuukausittainen sallittu määrä, tai null kun kuukausikiintiö on rajoittamaton. Nullia ei saa tulkita nollaksi. |
data.quota.used |
integer | Onnistuneet, lasketut API-toiminnot nykyisen käyttöjakson aikana, mukaan lukien krediittejä käyttävät toiminnot. Tilannetarkistukset eivät kasvata tätä arvoa. |
data.quota.purchased_credits |
integer | Nykyinen krediittisaldo, mukaan lukien aktiivisen suunnitelman bonuskrediitit. Bonuskrediittejä ei saa lisätä tähän saldoon toisen kerran. |
data.quota.bonus_credits |
integer | Aktiivinen suunnitelman bonuksen osuus krediittisaldosta; purchased_credits:n erittely, ei lisäkapasiteettia. |
data.quota.direct_purchased_credits |
integer | Krediittisaldo ilman aktiivisen suunnitelman bonuksen osuutta. Tämä arvo plus bonus_credits on yhtä kuin purchased_credits. |
data.quota.remaining |
integer|null | Kuukausittainen jäljellä oleva sallittu määrä plus nykyinen krediittitasapaino, ilman bonusten kaksinkertaista laskemista. Null tarkoittaa rajoittamatonta kuukausikiintiötä. Yksittäiset ominaisuusluvat ja muut pyyntörajat pätevät edelleen. |
data.quota.unlimited |
boolean | Onko kuukausikiintiö rajoittamaton. Tämä ei tee tilin minuuttibudjettia tai muiden ominaisuuksien rajoja rajoittamattomiksi. |
data.quota.usage_percent |
integer | Dashboard-yhteensopiva pyöristetty prosentti 0–100: käytetty jaettuna (käytetty + jäljellä oleva), kerrottuna 100:lla. Se sisältää käytettävissä olevan luottokapasiteetin, joten lataaminen voi alentaa prosenttia. Se on 0, jos on rajoittamaton kiintiö tai nollakokoinen varanto; se ei ole minuutin nopeusrajoituksen prosentti eikä pääsypäätös. |
data.quota.reset_at |
string | ISO-8601-aikaleima aikavyöhykkeen siirtymällä seuraavan kalenterikuukauden kiintiön nollaukseen. Tämä ei ole tilauksen päättymispäivä, eikä kuukausittainen nollaus täydennä ostettuja krediittejä. |
status |
string | Kirjaimellinen onnistuminen tälle tilapisteelle. Muut onnistuneet postilaatikon päätepisteet käyttävät totuusarvoa true. |
data.monthly_limit |
integer | Yhteensopivuusalias vastaavalle data.quota -kentälle; älä lisää sitä uudelleen laskettaessa saldoja. |
data.monthly_remaining |
integer|null | Yhteensopivuusalias vastaavalle data.quota -kentälle; älä lisää sitä uudelleen laskettaessa saldoja. |
data.purchased_credits |
integer | Yhteensopivuusalias vastaavalle data.quota -kentälle; älä lisää sitä uudelleen laskettaessa saldoja. |
Postilaatikko-webhookit (reaaliaikainen push)
Sen sijaan että toistuvasti pyytää REST-salamankäynnin (GET /messias) tarkastella sisäpäästettyjä sähköpostiä, aseta välineet (vahinkot) tuomaan uusia viestejä sinun palvelulle tai automaatioprosessille reaaliaikaisesti.
Tuen Webhook-tapahtumat
Jokainen webhook voi tilata yhden tai useamman tapahtumatyypin. Endpointi saa tapahtumankuulutuksen, kun jokin näistä laukaisuista tapahtuu.
Lähetetään reaaliajassa aina, kun uusi viesti saapuu valittuun postilaatikkoon.
Lähetetään, kun tilapäinen postilaatikko vanhenee ja webhook‑käsittely on pysäytetty.
Lähetetään, kun vanhentunut postilaatikko aktivoituu uudelleen suunnitelman sääntöjen mukaisesti.
Lähetetty juuri ennen kuin webhook ja sen postilaatikko poistetaan.
Pyynnön päätavoitteet & HMAC-allekirjoituksen tarkistus
Jokainen webhook-lähetys sisältää erityiset turvamerkkien päätteen. Käytä X-TempMailg-Signature -päätettä varmistamaan, että saapuneet pyynnöt on lähetetty todella TempMailg:ltä ja että niitä ei ole muutettu.
| Otsikko | Esimerkkiarvo | Kuvaus |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Webhook‑toimitustyöntekijän vakiotunniste. |
X-TempMailg-Event |
email.received | Tapahtuman tyyppi, joka käynnisti tämän toimituksen. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | Tälle toimitusyritykselle annettu ainutlaatuinen UUID. |
X-TempMailg-Timestamp |
1725192000 | Unix-epookin aikaleima, joka osoittaa, milloin pyyntö aloitettiin. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | HMAC-SHA256-allekirjoitus, joka on laskettu kohteesta {timestamp}.{raw_body} käyttäen salaisuuttasi. |
X-TempMailg-Test |
false | Tosi, kun lähetetään "Send Test Ping" -toiminnolla hallintapaneelissasi. |
Allekirjoitus lasketaan HMAC:lla SHA256:n avulla seuraavasta merkkijonosta:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Esimerkkitapahtumalataus (email.received)
Toimitetaan sovelluksen muotoisena JSONina HTTP POST-pyyntöruumiin.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:18:03+00:00",
"test": false,
"mailbox": {
"id": 1024,
"email": "developer@v1.tempmailg.com"
},
"data": {
"message_id": "7a8b9c0d1e2f",
"subject": "Your Verification Code: 948201",
"from": "auth@service.com",
"to": "developer@v1.tempmailg.com",
"date": "2026-11-19T02:18:03+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"
}
}
Vastaanottimen toteutusesimerkit
Valitse kielesi nähdäksesi, miten vastaanottaa webhookit ja tarkistaa HMAC-allekirjoitukset turvallisesti.
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]);
Tuetut alustat ja automaatiointegraatiot
TempMailg Webhookit toimivat suoraan standardien HTTPS-päätepisteiden ja johtavien koodittomien/automaatioalustojen kanssa:
Yleiset virheet ja vianmääritys
Nämä ovat yleisimmät vastauskoodit, joita voit nähdä käyttäjän API:n integroinnin aikana.
Virheellinen, puuttuva tai peruutettu Bearer token.
Omistajuus, ominaisuusluvat, domain-pääsy tai liitetiedoston koko estivät toiminnon. Tarkista vastauskoodi ja -viesti.
Resurssia ei löydy sallitulta isännöitsijältä tai se ei kuulu käyttäjälle.
Toimintanäppäintä käytettiin uudelleen eri tiedoilla, toinen toiminto on odottamassa tai postilaatikon turvallisuus on muuttunut. Tarkista koodi ennen uudelleenyritystä.
Postilaatikko on vanhentunut tai ei ole aktiivinen.
Virheelliset parametrit, kielletty elinkaari, aliaskapasiteetti ei ole käytettävissä, virheellinen PIN-asetus tai puuttuva/virheellinen Idempotency-Key estivät toiminnon.
Suojattu postilaatikko tarvitsee kelvollisen laajennetun X-Mailbox-Unlock -tokenin. Käytä vastauksessa olevia action- ja target_id-arvoja poistamiseen. Lukitus- tai palautusvaatimukset on ratkaistava ennen uudelleenyritystä.
Pyyntöraja, poistettu suunnitelma, loppunut kiintiö tai jäähdytys esti toiminnon. Tarkista syy ja käytettävissä olevat budjettipäät. Retry-After on valinnainen.
Palvelin ei voinut suorittaa toimintoa. Suojatun luomisen tai poistamisen yhteydessä säilytä sama pyyntö ja Idempotency-Key, kun yrität uudelleen.
Suojaustallennusta tai koordinointia ei voitu vahvistaa. Yritä uudelleen ilmoitetun viiveen jälkeen. Tämä vastaus ei ole epäonnistunut maksu.
Nopea tarkistuslista
- 401 Unauthorized - Bearer-merkintä puuttuu, on väärä, mitätöity tai kopioitu väärin.
- 403 Forbidden - Nykyinen suunnitelma ei ole käyttäjän API-käyttöoikeuksia tällä hetkellä.
- 404 Not Found - Resurssia ei löydy tai parametri on virheellinen
- 410 Gone / Expired - Postilaatikko on vanhentunut tai ei ole enää aktiivinen.
- 429 Rate Limited - Tarkista vastauksen syy ja budjettiotsikot. Retry-After koskee vain aikarajoja; loppuneet krediitit tai poistettu pääsy saattavat vaatia tilin muutoksen.
Suositeltu seuraava vaihe
Jos olet kirjautunut sisään, avaa ensin API-hallinta ja vahvista avain, kiintiö, suunnitelman pääsytila ja tarkka käyttäjän API-perus-URL ennen ulkoisen sovelluksen virheenjäljitystä.