TempMail API-dokumentasie

REST API v1 & Webhooks

TempMailg Ontwikkelaar API-dokumentasie

Gebruik hierdie dokumentasie om jou persoonlike API-sleutel te genereer, verbind die toegewysde gebruiker API-gasheer, lees posbusboodskappe, bestuur besit posbusse en integreer Temp Mail in jou eie toepassings of outomatiserings.

Bearer Token Verifikasie Regstreekse Webhooks Gmail & Outlook-aliasse JSON-reaksies
Gebruiker API-basis-URL HTTPS
Aanvraagformaat Gebruik jou API-sleutel slegs in die Outentikasie Bearer-koptekst en hou endpoint-URL's skoon.

Posbusbestuur

Haal toegelate domeine op, skep of skakel posbusse, kies toegelate lewensduur, en verwyder besitende adresse.

GET https://v1.tempmailg.com/api/domains?type={type}
#

Lys Toegelate Domeine

Lys beskikbare domeine vir die skep van tydelike e-posse. Filter volgens tipe om slegs gratis, premium of pasgemaakte domeine te sien wat deur jou intekenplan ondersteun word.

Parameters 1
Parameter Ligging Tipe Status Beskrywing
type query string opsioneel
Domein-vlak filter. Omslaan gebruik alles wanneer premium-domein toegang geaktiveer is, anders gratis. Erkende waardes: free, basic, pro, premium, custom, ultimate, all
Verstek: Rekening-afhanklik
Haal toegelate domeine
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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
            }
        ]
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.requested_type string
Toegepaste domeinfilter.
data.plan string
Huidige planetiket.
data.plan_name string
Leesbare naam van die huidige plan.
data.allowed_types array<string>
Domeinfilters beskikbaar vir hierdie rekening. 'n Erkende filter kan steeds verbied word vir jou plan.
data.domains array
Kiesbare domeine na filtrering; 'n leë reeks is geldig.
data.domains[].domain string
Kiesbare domeinnaam.
data.domains[].type string
Leesbare domeinvlaketiket.
data.domains[].custom boolean
Of dit 'n pasgemaakte domein is.
POST https://v1.tempmailg.com/api/emails
#

Skep tydelike posbus

Skep 'n eienaars se tydelike posbus. Slaan gebruikersnaam en domein oor vir willekeurige generering, of verskaf 'n toegelate pasgemaakte gebruikersnaam en 'n toegelate domein. Die verskafferparameter kan Gmail of Outlook aliasgenerering kies.

Parameters 8
Parameter Ligging Tipe Status Beskrywing
username body string opsioneel
Opsionele pasgemaakte gebruikersnaam: 2 tot 64 ASCII letters, syfers, punte, onderstrepings of koppelteken. Vereis plantoestemming; custom_username word ook aanvaar.
Verstek: Willekeurig gegenereer
domain body string opsioneel
Een van die toegelate domeine wat deur GET /domains teruggegee word. Omission kies 'n ewekansige toegelate domein.
Verstek: Willekeurige toegelate domein
lifetime body string opsioneel
toegelate waardes:
10m — 10 Minute 1h — 1 Uur 2h — 2 ure 1d — 1 dag 1w — 1 Week 1m — 30 Dae 3m — 90 dae 6m — 180 Dae 1y — 365 Dae unlimited — Onbeperk
Verstek: Plan standaard leeftyd
provider body string opsioneel
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
Verstek: standard
pin_enabled body boolean opsioneel
Opsionele PIN-beskerming vir die nuwe posbus, wanneer deur jou plan toegelaat. Dit verander nie die PIN van 'n bestaande posbus nie.
Verstek: false
pin body string opsioneel
Vereis wanneer pin_enabled waar is: 'n PIN van 6 tot 8 syfers, as 'n string gestuur om voorste nulles te behou.
pin_confirmation body string opsioneel
Vereis wanneer pin_enabled waar is. Moet presies ooreenstem met pin.
Idempotency-Key header string opsioneel
Vereis vir PIN-beskermde skepping of verwydering: ‘n stabiele sleutel van 16 tot 128 karakters. Probeer dieselfde versoek weer met dieselfde sleutel om dupliserende werk te vermy.
Opsionele liggaamparameters: username (pasgemaakte gebruikersnaam indien deur plan toegelaat), domain (toegelaten domein, bv. example.com), lifetime (toegelate waardes: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Slaan lewensduur oor, of laat dit leeg, om die Verstek E-pos Lewensduur te gebruik wat vir jou huidige maandelikse/jaarlikse plan gekonfigureer is. Stuur 'n toegelate lewensduur soos 1h om daardie verstek te oorskryf. Onbeperk word slegs gebruik wanneer dit as die plan se verstek gekonfigureer is of uitdruklik versoek en toegelaat word. Die liggaamparameters mailbox_lifetime en email_lifetime word ook aanvaar; die eerste nie-leë waarde wen in hierdie volgorde: lifetime, mailbox_lifetime, email_lifetime. Ongeldige of nie-toegelaatbare waardes keer HTTP 422 terug in plaas van stilweg 'n verstek te kies.
Skep posbus
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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:56+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:56+00:00",
        "email_token": "encrypted-email-token"
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.id integer
Posbus-ID. Gegenereerde ID's, adresse en tokens verskil vir elke posbus.
data.pin_protected boolean
Of hierdie posbus PIN-beskerming het. Geen PIN of PIN-hash word teruggegee nie.
data.email string
Volledige posbusadres gegenereer.
data.domain string
Domein van die gegenereerde posbus.
data.provider string
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
data.expire_at string|null
Effektiewe vervaldatum as 'n ISO-8601 tydstempel, of null vir 'n onbeperkte posbus.
data.expires_in_seconds number|null
Nie-negatiewe sekondes wat oorbly wanneer bereken; breuksekondes is moontlik. Null beteken onbeperk, nie nul nie.
data.mailbox_state string
Huidige posbusstatus: aktief, gepauzeer, verval, of onaktief.
data.receiving_enabled boolean
Of hierdie posbus tans inkomende boodskappe aanvaar.
data.message_count integer
Bekende totale boodskaptelling; dit kan die laaste posbus-sinchronisasie weerspieël.
data.unread_message_count integer
Bekende ongeleeste boodskaptelling; dit kan die laaste posbus-sinkronisasie weerspieël.
data.last_message_received_at string|null
Laaste bekende ontvangde-boodskap tyd in ISO-8601-formaat, of null wanneer nie beskikbaar nie.
data.message_count_synced_at string|null
Laaste boodskap-telling sinchronisasietyd in ISO-8601-formaat, of null voor sinchronisasie.
data.created_at string|null
Poskas se skeppingstyd in ISO-8601-formaat.
data.email_token string
Ondoorsigtige versleutelde posbusverwysing. Dit vervang nie Bearer-verifikasie, eienaarskapkontroles of PIN-magtiging nie.
data.pin_grant object
Voorwaardelik: aktiewe PIN-beskermde posbus-skepping lewer hierdie lees-toestemming; gewone onbeveiligde skepping weier dit.
data.pin_grant.mailbox_id integer
Posbus-ID waaraan die voorwaardelike leestoekenning gekoppel is.
data.pin_grant.unlock_token string
Ondoorsigtige lees-token vir X-Mailbox-Unlock met dieselfde eienaar-referensie. Hou dit privaat en in die geheue; 'n lees-toekenning mag nie verwydering goedkeur nie.
data.pin_grant.scope string
Die omvang gelees vir die voorwaardelike skeppingstoekenning.
data.pin_grant.idle_timeout_seconds integer
Toegelate wagtyd vir die leestoestemming, gewoonlik 3600 sekondes.
data.pin_grant.absolute_timeout_seconds integer
Maksimum leeftyd van die leestoekenning, gewoonlik 86400 sekondes.
data.pin_grant.expires_at string
Huidige lees-toekenning vervaldatum in ISO-8601-formaat.
data.pin_grant.absolute_expires_at string
Absolute lees-toekenning verval in ISO-8601-formaat. Sekuriteitsveranderings kan die toekenning vroeër intrek.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Opdateer / Skakel Posbus

Skep of kies 'n posbus by die nuwe gebruikersnaam en domein nadat die eienaarskap van die huidige posbus bevestig is. Dit hernoem nie die ou posbus nie of verander die lewensduur daarvan op plek nie. Wanneer die bestemming verskil, bly die ou posbus in die geskiedenis en kan dit deur aktiewe-posbuslimiete gepouseer word. Deur jou eie aktiewe bestemming weer te gebruik, word die versoekte lewensduur of die standaardplan hertoegepas.

Parameters 9
Parameter Ligging Tipe Status Beskrywing
email path string vereis
Huidige volledige e-posadres van die besitde posbus om oor te skakel. URL-enkodeer elke padsegment; enkodeer 'n plusteken as %2B.
username path string vereis
Nuwe gewenste gebruikersnaam: 2 tot 64 alfanumeriese karakters; onderhewig aan aangepaste gebruikersnaam toestemming.
domain path string vereis
Nuwe toegelate domeinnaam.
lifetime body string opsioneel
toegelate waardes:
10m — 10 Minute 1h — 1 Uur 2h — 2 ure 1d — 1 dag 1w — 1 Week 1m — 30 Dae 3m — 90 dae 6m — 180 Dae 1y — 365 Dae unlimited — Onbeperk
Verstek: Plan standaard leeftyd
pin_enabled body boolean opsioneel
Opsionele PIN-beskerming vir die nuwe posbus, wanneer deur jou plan toegelaat. Dit verander nie die PIN van 'n bestaande posbus nie.
Verstek: false
pin body string opsioneel
Vereis wanneer pin_enabled waar is: 'n PIN van 6 tot 8 syfers, as 'n string gestuur om voorste nulles te behou.
pin_confirmation body string opsioneel
Vereis wanneer pin_enabled waar is. Moet presies ooreenstem met pin.
Idempotency-Key header string opsioneel
Vereis vir PIN-beskermde skepping of verwydering: ‘n stabiele sleutel van 16 tot 128 karakters. Probeer dieselfde versoek weer met dieselfde sleutel om dupliserende werk te vermy.
X-Mailbox-Unlock header string opsioneel
Kop, slegs beskermde posbusse: gebruik 'n lees unlock_token. Eerstens POST pin en scope=read na die PIN ontgrendel-URL. Hou jou normale Bearer-verifikasie. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Gebruik 'n bestaande besitte posbus e-pos in {email}. Opsionele liggaamparameter: lifetime (toegelate waardes: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Slaan lewensduur oor, of laat dit leeg, om die Verstek E-pos Lewensduur te gebruik wat vir jou huidige maandelikse/jaarlikse plan gekonfigureer is. Stuur 'n toegelate lewensduur soos 1h om daardie verstek te oorskryf. Onbeperk word slegs gebruik wanneer dit as die plan se verstek gekonfigureer is of uitdruklik versoek en toegelaat word. Die liggaamparameters mailbox_lifetime en email_lifetime word ook aanvaar; die eerste nie-leë waarde wen in hierdie volgorde: lifetime, mailbox_lifetime, email_lifetime. Ongeldige of nie-toegelaatbare waardes keer HTTP 422 terug in plaas van stilweg 'n verstek te kies.
Wysig besitte posbus
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'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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:56+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:56+00:00",
        "email_token": "encrypted-email-token"
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.id integer
Posbus-ID. Gegenereerde ID's, adresse en tokens verskil vir elke posbus.
data.pin_protected boolean
Of hierdie posbus PIN-beskerming het. Geen PIN of PIN-hash word teruggegee nie.
data.email string
Volledige posbusadres gegenereer.
data.domain string
Domein van die gegenereerde posbus.
data.provider string
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
data.expire_at string|null
Effektiewe vervaldatum as 'n ISO-8601 tydstempel, of null vir 'n onbeperkte posbus.
data.expires_in_seconds number|null
Nie-negatiewe sekondes wat oorbly wanneer bereken; breuksekondes is moontlik. Null beteken onbeperk, nie nul nie.
data.mailbox_state string
Huidige posbusstatus: aktief, gepauzeer, verval, of onaktief.
data.receiving_enabled boolean
Of hierdie posbus tans inkomende boodskappe aanvaar.
data.message_count integer
Bekende totale boodskaptelling; dit kan die laaste posbus-sinchronisasie weerspieël.
data.unread_message_count integer
Bekende ongeleeste boodskaptelling; dit kan die laaste posbus-sinkronisasie weerspieël.
data.last_message_received_at string|null
Laaste bekende ontvangde-boodskap tyd in ISO-8601-formaat, of null wanneer nie beskikbaar nie.
data.message_count_synced_at string|null
Laaste boodskap-telling sinchronisasietyd in ISO-8601-formaat, of null voor sinchronisasie.
data.created_at string|null
Poskas se skeppingstyd in ISO-8601-formaat.
data.email_token string
Ondoorsigtige versleutelde posbusverwysing. Dit vervang nie Bearer-verifikasie, eienaarskapkontroles of PIN-magtiging nie.
data.pin_grant object
Voorwaardelik: aktiewe PIN-beskermde posbus-skepping lewer hierdie lees-toestemming; gewone onbeveiligde skepping weier dit.
data.pin_grant.mailbox_id integer
Posbus-ID waaraan die voorwaardelike leestoekenning gekoppel is.
data.pin_grant.unlock_token string
Ondoorsigtige lees-token vir X-Mailbox-Unlock met dieselfde eienaar-referensie. Hou dit privaat en in die geheue; 'n lees-toekenning mag nie verwydering goedkeur nie.
data.pin_grant.scope string
Die omvang gelees vir die voorwaardelike skeppingstoekenning.
data.pin_grant.idle_timeout_seconds integer
Toegelate wagtyd vir die leestoestemming, gewoonlik 3600 sekondes.
data.pin_grant.absolute_timeout_seconds integer
Maksimum leeftyd van die leestoekenning, gewoonlik 86400 sekondes.
data.pin_grant.expires_at string
Huidige lees-toekenning vervaldatum in ISO-8601-formaat.
data.pin_grant.absolute_expires_at string
Absolute lees-toekenning verval in ISO-8601-formaat. Sekuriteitsveranderings kan die toekenning vroeër intrek.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Verwyder posbus

Verwyder 'n besitde posbus en roep sy boodskap- en lêeropruiming op. Behoude posbusrekords kan intern sagverwyder word; die adres is nie meer bruikbaar via die API nie.

Parameters 3
Parameter Ligging Tipe Status Beskrywing
email path string vereis
Volle e-posadres van die besitde posbus om te verwyder. URL-enkodeer die adres; enkodeer 'n plusteken as %2B.
X-Mailbox-Unlock header string opsioneel
Kop, slegs beskermde posbusse: gebruik die eenmalige verwyder ontgrendel_token. Eerstens POST pin, scope=delete en die aksie/target_id wat deur die 423-respons na die PIN ontgrendel-URL teruggegee word. ’n Lees-token kan nie verwyder nie. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string opsioneel
Vereis vir PIN-beskermde skepping of verwydering: ‘n stabiele sleutel van 16 tot 128 karakters. Probeer dieselfde versoek weer met dieselfde sleutel om dupliserende werk te vermy.
Skrap besitte posbus
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
message string
Resultaat van die verwydering. 'n ontbrekende hulpbron lewer HTTP 404 terug.

Gmail & Outlook-aliasse

Genereer hoë-reputasie Gmail- en Outlook/Hotmail-alias-posbusse.

POST https://v1.tempmailg.com/api/gmail-alias/emails
#

Skep Gmail Alias

Skep 'n nuwe Gmail-aliastydelike posbus wat aan die geverifieerde gebruiker behoort.

Parameters 8
Parameter Ligging Tipe Status Beskrywing
mode body string opsioneel
Generasie-modus: auto, dot, plus, of plus_dot. Aanvaar ook gmail_alias_mode. As stylkeuse nie toegelaat word nie, word auto gebruik.
Verstek: auto
username body string opsioneel
Opsionele pasgemaakte alias-agtervoegsel: 2 tot 32 ASCII letters of syfers, genormaliseer na kleinletters; onderhewig aan funksietoestemming. Aanvaar ook custom_username of alias_username.
Verstek: Outomaties gegenereer
domain body string opsioneel
Gebruik ewekansig, gmail.com of googlemail.com; alias_domain word ook aanvaar. Weglaat of onbeskikbare domein-keuse toestemming gebruik ewekansig.
Verstek: random
lifetime body string opsioneel
toegelate waardes:
10m — 10 Minute 1h — 1 Uur 2h — 2 ure 1d — 1 dag 1w — 1 Week 1m — 30 Dae 3m — 90 dae 6m — 180 Dae 1y — 365 Dae unlimited — Onbeperk
Verstek: Plan standaard leeftyd
pin_enabled body boolean opsioneel
Opsionele PIN-beskerming vir die nuwe posbus, wanneer deur jou plan toegelaat. Dit verander nie die PIN van 'n bestaande posbus nie.
Verstek: false
pin body string opsioneel
Vereis wanneer pin_enabled waar is: 'n PIN van 6 tot 8 syfers, as 'n string gestuur om voorste nulles te behou.
pin_confirmation body string opsioneel
Vereis wanneer pin_enabled waar is. Moet presies ooreenstem met pin.
Idempotency-Key header string opsioneel
Vereis vir PIN-beskermde skepping of verwydering: ‘n stabiele sleutel van 16 tot 128 karakters. Probeer dieselfde versoek weer met dieselfde sleutel om dupliserende werk te vermy.
Vereis dat die Gmail Alias API-magtiging op jou intekenplan geaktiveer is of ontgrendel word via 'n API-kredietpakket. Opsionele parameters: mode (auto, dot, plus, plus_dot), username (pasgemaakte alias gebruikersnaam), domain (bv. gmail.com, googlemail.com), lifetime (toegelate waardes: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Slaan lewensduur oor, of laat dit leeg, om die Verstek E-pos Lewensduur te gebruik wat vir jou huidige maandelikse/jaarlikse plan gekonfigureer is. Stuur 'n toegelate lewensduur soos 1h om daardie verstek te oorskryf. Onbeperk word slegs gebruik wanneer dit as die plan se verstek gekonfigureer is of uitdruklik versoek en toegelaat word. Die liggaamparameters mailbox_lifetime en email_lifetime word ook aanvaar; die eerste nie-leë waarde wen in hierdie volgorde: lifetime, mailbox_lifetime, email_lifetime. Ongeldige of nie-toegelaatbare waardes keer HTTP 422 terug in plaas van stilweg 'n verstek te kies.
Skep Gmail alias-posbus
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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:56+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:56+00:00",
        "email_token": "encrypted-email-token"
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.id integer
Posbus-ID. Gegenereerde ID's, adresse en tokens verskil vir elke posbus.
data.pin_protected boolean
Of hierdie posbus PIN-beskerming het. Geen PIN of PIN-hash word teruggegee nie.
data.email string
Volledige posbusadres gegenereer.
data.domain string
Domein van die gegenereerde posbus.
data.provider string
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
data.expire_at string|null
Effektiewe vervaldatum as 'n ISO-8601 tydstempel, of null vir 'n onbeperkte posbus.
data.expires_in_seconds number|null
Nie-negatiewe sekondes wat oorbly wanneer bereken; breuksekondes is moontlik. Null beteken onbeperk, nie nul nie.
data.mailbox_state string
Huidige posbusstatus: aktief, gepauzeer, verval, of onaktief.
data.receiving_enabled boolean
Of hierdie posbus tans inkomende boodskappe aanvaar.
data.message_count integer
Bekende totale boodskaptelling; dit kan die laaste posbus-sinchronisasie weerspieël.
data.unread_message_count integer
Bekende ongeleeste boodskaptelling; dit kan die laaste posbus-sinkronisasie weerspieël.
data.last_message_received_at string|null
Laaste bekende ontvangde-boodskap tyd in ISO-8601-formaat, of null wanneer nie beskikbaar nie.
data.message_count_synced_at string|null
Laaste boodskap-telling sinchronisasietyd in ISO-8601-formaat, of null voor sinchronisasie.
data.created_at string|null
Poskas se skeppingstyd in ISO-8601-formaat.
data.email_token string
Ondoorsigtige versleutelde posbusverwysing. Dit vervang nie Bearer-verifikasie, eienaarskapkontroles of PIN-magtiging nie.
data.pin_grant object
Voorwaardelik: aktiewe PIN-beskermde posbus-skepping lewer hierdie lees-toestemming; gewone onbeveiligde skepping weier dit.
data.pin_grant.mailbox_id integer
Posbus-ID waaraan die voorwaardelike leestoekenning gekoppel is.
data.pin_grant.unlock_token string
Ondoorsigtige lees-token vir X-Mailbox-Unlock met dieselfde eienaar-referensie. Hou dit privaat en in die geheue; 'n lees-toekenning mag nie verwydering goedkeur nie.
data.pin_grant.scope string
Die omvang gelees vir die voorwaardelike skeppingstoekenning.
data.pin_grant.idle_timeout_seconds integer
Toegelate wagtyd vir die leestoestemming, gewoonlik 3600 sekondes.
data.pin_grant.absolute_timeout_seconds integer
Maksimum leeftyd van die leestoekenning, gewoonlik 86400 sekondes.
data.pin_grant.expires_at string
Huidige lees-toekenning vervaldatum in ISO-8601-formaat.
data.pin_grant.absolute_expires_at string
Absolute lees-toekenning verval in ISO-8601-formaat. Sekuriteitsveranderings kan die toekenning vroeër intrek.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Outlook Aliasdomeine

Haal aktiewe Outlook / Hotmail aliasdomeine op wat beskikbaar is vir posbusgenerering.

Vereis dat die Outlook Alias API-magtiging geaktiveer is op jou intekenplan of ontsluit word via 'n API-kredietpakket. Dui aan of spesifieke domeinseleksie op jou plan ontgrendeld is.
Kry Outlook-aliaskdomeine
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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
            }
        ]
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.domains array
Aktiewe Outlook/Hotmail-domeine; 'n leë reeks is geldig.
data.domains[].domain string
Beskikbare domeinnaam.
data.domains[].type string
Leesbare verskafferetiket.
data.domains[].selectable boolean
Of jou rekening hierdie domein uitdruklik kan kies.
data.domains[].locked boolean
Of eksplisiete domeinseleksie vir jou rekening gesluit is.
data.domains[].disabled_reason string|null
Rede vir domeinseleksie is gesluit, of null wanneer selekteerbaar.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Skep Outlook-alias

Skep 'n nuwe Outlook / Hotmail alias tydelike posbus wat deur die geauthentiseerde gebruiker besit word.

Parameters 7
Parameter Ligging Tipe Status Beskrywing
domain body string opsioneel
Gebruik ewekansig of 'n domein van GET /outlook-alias/domains; outlook_alias_domain word ook aanvaar. Sonder keuse-toestemming word ewekansig gebruik.
Verstek: Willekeurige beskikbare domein
username body string opsioneel
Opsionele pasgemaakte alias-agtervoegsel: 2 tot 32 ASCII letters of syfers, genormaliseer na kleinletters; onderhewig aan funksietoestemming. Aanvaar ook custom_username of alias_username.
Verstek: Outomaties gegenereer
lifetime body string opsioneel
toegelate waardes:
10m — 10 Minute 1h — 1 Uur 2h — 2 ure 1d — 1 dag 1w — 1 Week 1m — 30 Dae 3m — 90 dae 6m — 180 Dae 1y — 365 Dae unlimited — Onbeperk
Verstek: Plan standaard leeftyd
pin_enabled body boolean opsioneel
Opsionele PIN-beskerming vir die nuwe posbus, wanneer deur jou plan toegelaat. Dit verander nie die PIN van 'n bestaande posbus nie.
Verstek: false
pin body string opsioneel
Vereis wanneer pin_enabled waar is: 'n PIN van 6 tot 8 syfers, as 'n string gestuur om voorste nulles te behou.
pin_confirmation body string opsioneel
Vereis wanneer pin_enabled waar is. Moet presies ooreenstem met pin.
Idempotency-Key header string opsioneel
Vereis vir PIN-beskermde skepping of verwydering: ‘n stabiele sleutel van 16 tot 128 karakters. Probeer dieselfde versoek weer met dieselfde sleutel om dupliserende werk te vermy.
Vereis dat die Outlook Alias API-magtiging geaktiveer is op jou intekenplan of ontsluit word via 'n API-kredietpakket. Opsionele parameters: domain (bv. outlook.com, hotmail.com), username (pasgemaakte alias gebruikersnaam), lifetime (toegelate waardes: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Slaan lewensduur oor, of laat dit leeg, om die Verstek E-pos Lewensduur te gebruik wat vir jou huidige maandelikse/jaarlikse plan gekonfigureer is. Stuur 'n toegelate lewensduur soos 1h om daardie verstek te oorskryf. Onbeperk word slegs gebruik wanneer dit as die plan se verstek gekonfigureer is of uitdruklik versoek en toegelaat word. Die liggaamparameters mailbox_lifetime en email_lifetime word ook aanvaar; die eerste nie-leë waarde wen in hierdie volgorde: lifetime, mailbox_lifetime, email_lifetime. Ongeldige of nie-toegelaatbare waardes keer HTTP 422 terug in plaas van stilweg 'n verstek te kies.
Skep Outlook alias posbus
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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:56+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:56+00:00",
        "email_token": "encrypted-email-token"
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.id integer
Posbus-ID. Gegenereerde ID's, adresse en tokens verskil vir elke posbus.
data.pin_protected boolean
Of hierdie posbus PIN-beskerming het. Geen PIN of PIN-hash word teruggegee nie.
data.email string
Volledige posbusadres gegenereer.
data.domain string
Domein van die gegenereerde posbus.
data.provider string
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
data.expire_at string|null
Effektiewe vervaldatum as 'n ISO-8601 tydstempel, of null vir 'n onbeperkte posbus.
data.expires_in_seconds number|null
Nie-negatiewe sekondes wat oorbly wanneer bereken; breuksekondes is moontlik. Null beteken onbeperk, nie nul nie.
data.mailbox_state string
Huidige posbusstatus: aktief, gepauzeer, verval, of onaktief.
data.receiving_enabled boolean
Of hierdie posbus tans inkomende boodskappe aanvaar.
data.message_count integer
Bekende totale boodskaptelling; dit kan die laaste posbus-sinchronisasie weerspieël.
data.unread_message_count integer
Bekende ongeleeste boodskaptelling; dit kan die laaste posbus-sinkronisasie weerspieël.
data.last_message_received_at string|null
Laaste bekende ontvangde-boodskap tyd in ISO-8601-formaat, of null wanneer nie beskikbaar nie.
data.message_count_synced_at string|null
Laaste boodskap-telling sinchronisasietyd in ISO-8601-formaat, of null voor sinchronisasie.
data.created_at string|null
Poskas se skeppingstyd in ISO-8601-formaat.
data.email_token string
Ondoorsigtige versleutelde posbusverwysing. Dit vervang nie Bearer-verifikasie, eienaarskapkontroles of PIN-magtiging nie.
data.pin_grant object
Voorwaardelik: aktiewe PIN-beskermde posbus-skepping lewer hierdie lees-toestemming; gewone onbeveiligde skepping weier dit.
data.pin_grant.mailbox_id integer
Posbus-ID waaraan die voorwaardelike leestoekenning gekoppel is.
data.pin_grant.unlock_token string
Ondoorsigtige lees-token vir X-Mailbox-Unlock met dieselfde eienaar-referensie. Hou dit privaat en in die geheue; 'n lees-toekenning mag nie verwydering goedkeur nie.
data.pin_grant.scope string
Die omvang gelees vir die voorwaardelike skeppingstoekenning.
data.pin_grant.idle_timeout_seconds integer
Toegelate wagtyd vir die leestoestemming, gewoonlik 3600 sekondes.
data.pin_grant.absolute_timeout_seconds integer
Maksimum leeftyd van die leestoekenning, gewoonlik 86400 sekondes.
data.pin_grant.expires_at string
Huidige lees-toekenning vervaldatum in ISO-8601-formaat.
data.pin_grant.absolute_expires_at string
Absolute lees-toekenning verval in ISO-8601-formaat. Sekuriteitsveranderings kan die toekenning vroeër intrek.

Boodskappe & Aanhegsels

Haal inkomende inkassies op, lees volle HTML/teksboodskappe, en stroom aanhangsels.

GET https://v1.tempmailg.com/api/messages?email={email}
#

Lys posbusboodskappe

Haal beskikbare boodskapopsommings en posbusmetadata op. Standaard inkasskanderings gee 'n onlangse bondel van tot 25 boodskappe terug; dit is nie 'n gepagineerde volgeskiedenis-eindpunt nie. Gebruik GET /messages/{messageId} vir volledige liggame en aanhegsels.

Parameters 2
Parameter Ligging Tipe Status Beskrywing
email query string vereis
Volle e-posadres van die eienaar se posbus om boodskappe vanaf te lees. URL-enkodeer die navraagwaarde; enkodeer 'n plusteken as %2B.
X-Mailbox-Unlock header string opsioneel
Kop, slegs beskermde posbusse: gebruik 'n lees unlock_token. Eerstens POST pin en scope=read na die PIN ontgrendel-URL. Hou jou normale Bearer-verifikasie. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Die e-pos moet aan jou rekening behoort. Standaard- en Gmail-opsommings bevat OTP- en verification-link-velde; Outlook sluit ook from_name, snippet, received_at en has_attachments in. Verskaffer-sinkronisasie en kas kan nuwe boodskappe en tellinge vertraag.
Lees posbusboodskappe
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'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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:56",
            "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:56+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:56+00:00",
    "message_count_synced_at": "2026-11-19T02:17:56+00:00"
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
mailbox string
Posbusadres waarvan die boodskappe versoek is.
email_token string
Onduidelike versleutelde posbusverwysing; normale verifikasie is steeds nodig.
mailbox_provider string
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
messages array
Boodskapopsommings. 'n Leë inkassie lewer 'n leë reeks; haal 'n enkele boodskap op vir die liggaam en aanhegsels.
expire_at string|null
Effektiewe vervaldatum as 'n ISO-8601 tydstempel, of null vir 'n onbeperkte posbus.
expires_in_seconds number|null
Nie-negatiewe sekondes wat oorbly wanneer bereken; breuksekondes is moontlik. Null beteken onbeperk, nie nul nie.
mailbox_state string
Huidige posbusstatus: aktief, gepauzeer, verval, of onaktief.
receiving_enabled boolean
Of hierdie posbus tans inkomende boodskappe aanvaar.
message_count integer
Bekende totale boodskaptelling; dit kan die laaste posbus-sinchronisasie weerspieël.
unread_message_count integer
Bekende ongeleeste boodskaptelling; dit kan die laaste posbus-sinkronisasie weerspieël.
last_message_received_at string|null
Laaste bekende ontvangde-boodskap tyd in ISO-8601-formaat, of null wanneer nie beskikbaar nie.
message_count_synced_at string|null
Laaste boodskap-telling sinchronisasietyd in ISO-8601-formaat, of null voor sinchronisasie.
mailbox_limit.limit integer
Aktiewe posbuslimiet vir hierdie verskaffer; -1 beteken onbeperk.
mailbox_limit.limit_label string
Vertoonetiket vir die posbuslimiet.
mailbox_limit.active_count integer
Aantal aktiewe posbusse vir hierdie verskaffer.
mailbox_limit.paused_count integer
Aantal gepauseerde posbusse vir hierdie verskaffer.
mailbox_limit.paused_mailboxes array<string>
Adresse gepouseer deur die posbuslimiet.
mailbox_limit.remaining integer
Oorblywende aktiewe poskasplekke; -1 beteken onbeperk. Dit is nie API-versoekkwota nie.
mailbox_limit.remaining_label string
Vertoon etiket vir oorblywende posbusgleuwe.
mailbox_limit.reached boolean
Of die aktiewe poskaslimiet bereik is.
mailbox_limit.blocked boolean
Of die aktiewe posbuslimiet nul is.
mailbox_limit.provider string|null
Verskaffer waarop die posbuslimiet van toepassing is.
messages[].id string
Ondoorzigtige boodskap-ID wat deur die enkelboodskap-, verwyderings- en aanhegsel-eindpunte gebruik word.
messages[].is_seen boolean
Of die boodskap as gelees gemerk is.
messages[].subject string
Boodskaponderwerp.
messages[].from string
Afsender se vertoonnaam of adres.
messages[].from_email string
Afzender e-posadres.
messages[].receivedAt string
Ontvangstyd in die toepassings se tydsone, geformateer as YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Eenmalige kode opgespoor wanneer beskikbaar en toegelaat; anders null.
messages[].otp_locked boolean
Of 'n opgespoor eenmalige kode versteek word deur funksievergunninge.
messages[].verification_link string|null
Gedetecteerde verifikasie-URL wanneer beskikbaar en toegelaat; andersins null.
messages[].verification_link_locked boolean
Of 'n opgespoor verifikasiekoppie verberg word deur funksietoestemmings.
messages[].from_name string|null
Outlook-samenvattingsveld: oorspronklike afsender se naam. Afwesig in Standaard- en Gmail-samenvattings.
messages[].snippet string|null
Outlook-opsommingsveld: kort boodskapvoorskou.
messages[].received_at string|null
Outlook-opsommingsveld: ISO-8601 ontvangde tyd, wanneer bekend.
messages[].has_attachments boolean
Outlook-opsommingsveld: of aanhegselmetadata bestaan. Aflaaibeschikbaarheid word afsonderlik nagegaan.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Kry enkele boodskap

Haal 'n besitde boodskap op volgens sy ondeursigtige boodskap-ID. Gee liggaamsformate en aanhangselmetadata terug. Liggaamsvelde hang af van die boodskapformaat; Outlook voeg verskaffer-spesifieke velde hieronder gelys toe.

Parameters 2
Parameter Ligging Tipe Status Beskrywing
messageId path string vereis
Unieke boodskap-ID wat in die boodskaplys teruggegee word.
X-Mailbox-Unlock header string opsioneel
Kop, slegs beskermde posbusse: gebruik 'n lees unlock_token. Eerstens POST pin en scope=read na die PIN ontgrendel-URL. Hou jou normale Bearer-verifikasie. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Lees een boodskap
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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:56",
        "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"
            }
        ]
    }
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
data.id string
Ondoorsigtige boodskap-ID.
data.is_seen boolean
Boodskap se leesstatus. Lees kan dit as gesien merk; gekasdata kan 'n vroeëre status weerspieël.
data.subject string
Boodskaponderwerp.
data.from string
Afsender se vertoonnaam of adres.
data.from_email string
Afzender e-posadres.
data.to string
Ontvanger se posbusadres.
data.mailbox_provider string
Posbusverskaffer: standard, gmail_alias, of outlook_alias.
data.receivedAt string
Ontvangstyd in die toepassings se tydsone, geformateer as YYYY-MM-DD HH:mm:ss.
data.html boolean
Of die boodskap 'n HTML-body het.
data.html_content string
HTML-body wanneer teenwoordig. Standaardboodskappe sonder HTML kan hierdie veld weglê. Behandel boodskapinhoud as onbetroubaar.
data.text_content string
Tekstinhoud wanneer teenwoordig; Standaardboodskappe mag ontsnapte teks in 'n pre-element bevat of hierdie veld weglê.
data.content string
Voorkeurinhoud vir vertoning, gewoonlik HTML wanneer beskikbaar.
data.attachments array
Aanhegselmetadata, of 'n leë reeks. Aflaaie vereis normale verifikasie en toepaslike PIN-magtiging.
data.attachments[].name string
Lêernaam om URL-encode as 'n enkele padsegment tydens aflaai.
data.attachments[].size integer
Aanhegselgrootte in grepe.
data.attachments[].url string
Geverifieerde Gebruiker API aflaai-URL by aanhegsels gevoeg met 'n lêernaam. 'n URL waarborg nie dat die plaaslike lêer beskikbaar is nie.
data.attachments[].extension string
Standaard/Gmail metadata-veld: lêeruitbreiding wanneer verskaf.
data.attachments[].id string
Outlook-metadata-veld: verskaffer-aanhegsel-ID.
data.attachments[].content_type string
Outlook-metadataveld: MIME-inhoudtipe.
data.from_name string|null
Outlook-detaillêer: oorspronklike afsender se naam.
data.to_email string|null
Outlook-detaillêer: oorspronklike ontvangeradres.
data.received_at string|null
Outlook-detaalveld: ISO-8601 ontvangde tyd.
data.has_html boolean
Outlook-detaillêer: of 'n HTML-body bestaan.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Wissel boodskap

Skrap 'n enkele besitte boodskap.

Parameters 3
Parameter Ligging Tipe Status Beskrywing
messageId path string vereis
Unieke boodskap-ID-string om permanent te verwyder.
X-Mailbox-Unlock header string opsioneel
Kop, slegs beskermde posbusse: gebruik die eenmalige verwyder ontgrendel_token. Eerstens POST pin, scope=delete en die aksie/target_id wat deur die 423-respons na die PIN ontgrendel-URL teruggegee word. ’n Lees-token kan nie verwyder nie. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string opsioneel
Vereis vir PIN-beskermde skepping of verwydering: ‘n stabiele sleutel van 16 tot 128 karakters. Probeer dieselfde versoek weer met dieselfde sleutel om dupliserende werk te vermy.
Skrap een boodskap
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Responsievelde
Veld Tipe Beskrywing
status boolean
Of die operasie geslaag het.
message string
Resultaat van die verwydering. 'n ontbrekende hulpbron lewer HTTP 404 terug.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Laai aanhegsel af

Laai 'n bylae af van 'n boodskap wat deur jou besit word.

Parameters 3
Parameter Ligging Tipe Status Beskrywing
messageId path string vereis
ID van die boodskap wat die lêer bevat.
filename path string vereis
Lêernaam en uitbreiding van die aanhegsel om af te laai.
X-Mailbox-Unlock header string opsioneel
Kop, slegs beskermde posbusse: gebruik 'n lees unlock_token. Eerstens POST pin en scope=read na die PIN ontgrendel-URL. Hou jou normale Bearer-verifikasie. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Sukses lewer lêerbytes, nie JSON nie. Oor-groot lêers lewer HTTP 403; ontbrekende of ontoeganklike plaaslike lêers lewer HTTP 404. URL-encode die lêernaam as 'n enkele padsegment. Heenhegselmetadata alleen verseker nie aflaaibeschikbaarheid nie.
Laai 'n bylae af
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
Aflaai-gedrag Hierdie eindpunt gee die aangevraagde lêer regstreeks terug in plaas van 'n JSON-lyf.
Responsievelde
Veld Tipe Beskrywing
Content-Disposition header
Suksesvolle respons laai die versoekte lêernaam af.
body binary
Lêergrepe by sukses, nie JSON nie. Foute keer JSON terug met 'n nie-2xx-status.

Tariefbeperkings & Kwotas

Monitor real-time versoekbudgette, tempo-beperkings en rekeningkwotas sonder om krediete te verbruik.

GET https://v1.tempmailg.com/api/rate-limit
#

Tarieflimiet & Kwota

Kontroleer jou huidige tempo limiet en kwota status sonder om enige API-gebruik te verbruik. Hierdie eindpunt is kwota-vry en trek nie maandelikse API-krediete af nie (misbruikbeskerming limiet: 60 versoeke/min).

X-RateLimit-* beskryf die aangedui versoekbudget; X-Quota-* beskryf maandelikse en gekoopte kapasiteit wanneer beskikbaar. X-Mailbox-RateLimit-* rapporteer die afsonderlike posbus skepping/aktualiseringbudget. 'n Posbus-only verwerping gebruik posbusomvang en sy eie herprobeervenster. Minuutlimiet verwerpings mag kwota-inligting weglê. Retry-After word slegs ingesluit vir 'n tydgebaseerde herprobeering; gedeaktiveerde toegang mag 'n rekeningverandering vereis. In hierdie suksesvolle statusrespons beskryf data.limit, data.remaining en data.reset die rekening se minuutbegroting, nie bestedingskrediete nie. Die data.quota object beskryf maandelikse toelae, kredietbalanse en gebruik. Die bestaande data.monthly_limit, data.monthly_remaining en data.purchased_credits velde bly aliasse van die ooreenstemmende quota-velde. ‘n Suksesvolle statuskontrole mag nie ‘n ander API-operasie magtig maak nie. Operasies vereis steeds geaktiveerde toegang, beskikbare kwota en toelating deur al die toepaslike limiete. Die kwota-snapshot beloof nie kapasiteit wat reeds gereserveer is deur ‘n lopende versoek nie.
Kontroleer tarieflimietstatus
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustratiewe respons met sintetiese data. ID's, adresse, tokens, tydstempels, planlimiete en tellings verskil. Voorbeeldleeftydes oorskryf nie jou plan se verstek nie. Responsveldbeskrywings identifiseer nullable en verskaffer-spesifieke velde.

Voorbeeldrespons
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"
        }
    }
}
Responsievelde
Veld Tipe Beskrywing
data.limit integer|string
Rekening versoeke-per-minuut limiet. Die string unlimited dui op 'n onbeperkte minuutbegroting; dit is onafhanklik van die maandelikse kwota.
data.remaining integer|string
Oorblywende rekening minute-begrotingsgleuwe, of die string onbeperk. 'n Positiewe waarde beteken nie dat API-krediete oorbly nie.
data.reset integer
Sekondes vir die rekening se minuutvenster, nie die maandelikse kwota-herstel nie. Versperde of onbeperkte minuutbegrote kan 'n nominale 60-sekondwaarde behou; dit beloof nie toegang na wag nie.
data.plan string
Huidige planetiket. Die leesbare plannaam word apart verskaf in data.quota.plan_name.
data.quota.enabled boolean
Of globale en plan/krediet API-toegang geaktiveer is. Dit dui nie die oorblywende kapasiteit aan nie of vervang die gebruiker API-skakelaar.
data.quota.user_api_status boolean
Of die gebruiker hul Gebruiker-API-skakelaar geaktiveer het. Operasies vereis hierdie skakelaar sowel as geaktiveerde toegang en beskikbare kapasiteit.
data.quota.plan_name string
Leesbare naam van die huidige plan.
data.quota.period string
Kalendermaand-gebruikstydperk in YYYY-MM-formaat, met die toepassings tydsone; nie noodwendig die intekening faktuurperiode nie.
data.quota.base_limit integer
Basis maandelikse plantoelaag. 'n waarde van -1 beteken onbeperk.
data.quota.extra_requests integer
Bykomende maandelikse toelae toegek aan die huidige gebruiksperiode; geskei van gekoopte krediete.
data.quota.monthly_limit integer
Basistoelaag plus huidige-periode ekstra versoeke. 'n Waarde van -1 beteken onbeperk. Aangekoopte krediete is nie ingesluit nie.
data.quota.monthly_remaining integer|null
Oorblywende eindige maandelikse toelaag, of null wanneer die maandelikse kwota onbeperk is. Null mag nie as nul geïnterpreteer word nie.
data.quota.used integer
Suksesvolle, getelde API-operasies in die huidige gebruiksperiode, insluitend operasies wat krediete gebruik. Statuskontroles verhoog nie hierdie waarde nie.
data.quota.purchased_credits integer
Huidige kredietbalans, insluitend aktiewe planbonuskrediete. Bonuskrediete mag nie nog 'n keer by hierdie balans gevoeg word nie.
data.quota.bonus_credits integer
Aktiewe planbonusdeel van die kredietbalans; 'n uiteensetting van gekochte_krediete, nie ekstra kapasiteit nie.
data.quota.direct_purchased_credits integer
Kredietbalans, uitgesluit die aktiewe plan-bonusdeel. Hierdie waarde plus bonus_credits is gelyk aan purchased_credits.
data.quota.remaining integer|null
Maandelikse oorblywende toelae plus die huidige kredietbalans, sonder om bonusse dubbel te tel. Null beteken onbeperkte maandelikse kwota. Individuele funksietoestemmings en ander versoeklimiete is steeds van toepassing.
data.quota.unlimited boolean
Of die maandelikse kwota onbeperk is. Dit maak nie die rekening se minuutbegroting of ander funksielimiete onbeperk nie.
data.quota.usage_percent integer
Dashboard-compatibel afgeronde persentasie van 0 tot 100: gebruik gedeel deur gebruik plus oorblywende, vermenigvuldig met 100. Dit sluit beskikbare kredietkapasiteit in, dus kan herlaai die persentasie verlaag. Dit is 0 vir onbeperkte kwota of 'n poel van nul grootte; dit is nie die minuut-tarieflimiet persentasie of 'n toegangbesluit nie.
data.quota.reset_at string
ISO-8601 tydstempel met tydsoneverskuiwing vir die volgende kalendermaand kwota-herstel. Dit is nie die subskripsievervaldatum nie, en die maandelikse herstel vul nie gekoopte krediete aan nie.
status string
Die letterlike sukses vir hierdie status-eindpunt. Ander suksesvolle posbus-eindpunte gebruik die boolean true.
data.monthly_limit integer
Kompatibiliteit alias van die ooreenstemmende data.quota-veld; voeg dit nie weer by wanneer saldo's bereken word nie.
data.monthly_remaining integer|null
Kompatibiliteit alias van die ooreenstemmende data.quota-veld; voeg dit nie weer by wanneer saldo's bereken word nie.
data.purchased_credits integer
Kompatibiliteit alias van die ooreenstemmende data.quota-veld; voeg dit nie weer by wanneer saldo's bereken word nie.

Posbus PIN Beskerming

Voer die PIN in om voort te gaan. Jou posbus bly ontgrend terwyl dit aktueel is in hierdie webwerf-sessie.

Aanvaar jy koekies?

Ons gebruik koekies om jou blaaiervaring te verbeter. Deur hierdie werf te gebruik, stem jy in tot ons koekiebeleid.

Meer