TempMail API-dokumentation

REST API v1 & Webhooks

TempMailg Utvecklare API-dokument

Använd denna dokumentation för att generera din personliga API-nyckel, ansluta den dedikerade användar-API-värden, läsa meddelanden i postlådan, hantera ägda postlådor och integrera Temp Mail i dina egna appar eller automatiseringar.

Bärartokenautentisering Webhooks i realtid Gmail & Outlook-alias JSON-svar
Användar-API-bas-URL HTTPS
Begär format Använd din API-nyckel endast i auktoriseringshuvudet Bearer och håll slutpunkts-URL:er rena.

Brevlådeshantering

Hämta tillåtna domäner, skapa eller byta brevlådor, välja tillåtna livstider, och radera ägda adresser.

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

Lista tillåtna domäner

Lista tillgängliga domäner för att skapa tillfälliga e‑postmeddelanden. Filtrera efter typ för att endast se gratis, premium eller anpassade domäner som stöds av din prenumerationsplan.

Parametrar 1
Parameter Plats Typ Status Beskrivning
type query string valfri
Domännivåfilter. Utelämning använder alla när premium-domänåtkomst är aktiverad, annars gratis. Kända värden: free, basic, pro, premium, custom, ultimate, all
Standard: Konto-beroende
Få tillåtna domäner
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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
            }
        ]
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.requested_type string
Tillämpt domänfilter.
data.plan string
Aktuell planetikett.
data.plan_name string
Läsbart namn på den aktuella planen.
data.allowed_types array<string>
Domänfilter tillgängliga för detta konto. Ett igenkänt filter kan fortfarande vara förbjudet för din plan.
data.domains array
Valbara domäner efter filtrering; en tom array är giltig.
data.domains[].domain string
Valbart domännamn.
data.domains[].type string
Läsbar domännivåetikett.
data.domains[].custom boolean
Om detta är en anpassad domän.
POST https://v1.tempmailg.com/api/emails
#

Skapa tillfällig brevlåda

Skapa en ägd temporär brevlåda. Utelämna användarnamn och domän för slumpmässig generering, eller ange ett tillåtet anpassat användarnamn och en godkänd domän. provider‑parametern kan välja Gmail‑ eller Outlook‑aliasgenerering.

Parametrar 8
Parameter Plats Typ Status Beskrivning
username body string valfri
Valfritt anpassat användarnamn: 2 till 64 ASCII-bokstäver, siffror, punkter, understreck eller bindestreck. Kräver planbehörighet; custom_username accepteras också.
Standard: Slumpmässigt genererad
domain body string valfri
En av de tillåtna domänerna som returneras av GET /domains. Utelämnande väljer en slumpmässig tillåten domän.
Standard: Slumpmässig tillåten domän
lifetime body string valfri
tillåtna värden:
10m — 10 minuter 1h — 1 timme 2h — 2 Timmar 1d — 1 dag 1w — 1 Vecka 1m — 30 dagar 3m — 90 dagar 6m — 180 dagar 1y — 365 dagar unlimited — Obegränsat
Standard: Planens standardlivstid
provider body string valfri
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
Standard: standard
pin_enabled body boolean valfri
Valfritt PIN-skydd för den nya brevlådan, när det tillåts av din plan. Det ändrar inte PIN-koden för en befintlig brevlåda.
Standard: false
pin body string valfri
Krävs när pin_enabled är true: en PIN på 6 till 8 siffror, skickad som en sträng för att bevara inledande nollor.
pin_confirmation body string valfri
Krävs när pin_enabled är true. Måste exakt matcha pin.
Idempotency-Key header string valfri
Krävs för PIN-skyddad skapning eller borttagning: en stabil nyckel på 16 till 128 tecken. Upprepa samma begäran med samma nyckel för att undvika duplicerat arbete.
Valfria body-parametrar: username (anpassat användarnamn om det tillåts av planen), domain (tillåtet domän, t.ex. example.com), lifetime (tillåtna värden: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Utelämna livstid, eller lämna den tom, för att använda standardlivstiden för e‑post som är konfigurerad för din nuvarande månatliga/årliga plan. Skicka en tillåten livstid, t.ex. 1h, för att åsidosätta standardvärdet. Obegränsat används endast när det är konfigurerat som planens standard eller uttryckligen begärt och tillåtet. Kroppsparametrarna mailbox_lifetime och email_lifetime accepteras också; det första icke‑tomma värdet vinner i följande ordning: lifetime, mailbox_lifetime, email_lifetime. Ogiltiga eller otillåtna värden returnerar HTTP 422 istället för att tyst välja ett standardvärde.
Skapa brevlåda
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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:19+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:19+00:00",
        "email_token": "encrypted-email-token"
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.id integer
Mailbox-ID. Genererade ID:n, adresser och token skiljer sig för varje brevlåda.
data.pin_protected boolean
Om denna brevlåda har PIN‑skydd. Ingen PIN eller PIN‑hash returneras.
data.email string
Genererad fullständig brevlådadress.
data.domain string
Domän för den genererade brevlådan.
data.provider string
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
data.expire_at string|null
Effektiv utgångstid som en ISO-8601 tidsstämpel, eller null för en obegränsad brevlåda.
data.expires_in_seconds number|null
Icke-negativa sekunder kvar när beräknat; bråkdelar av sekunder är möjliga. Null betyder obegränsat, inte noll.
data.mailbox_state string
Aktuell brevlådestatus: aktiv, pausad, utgången eller inaktiv.
data.receiving_enabled boolean
Om den här brevlådan för närvarande accepterar inkommande meddelanden.
data.message_count integer
Känt totalt meddelandeantal; det kan återspegla den senaste brevlådesynkroniseringen.
data.unread_message_count integer
Känd oläst meddelandeantal; det kan återspegla den senaste postlådesynkroniseringen.
data.last_message_received_at string|null
Senast kända mottagna meddelandetid i ISO-8601-format, eller null när otillgänglig.
data.message_count_synced_at string|null
Senaste synkroniseringstid för meddelandeantal i ISO-8601-format, eller null före synkronisering.
data.created_at string|null
Skapandetid för brevlåda i ISO-8601-format.
data.email_token string
Opak krypterad brevlådereferens. Den ersätter inte Bearer-autentisering, ägarkontroller eller PIN-auktorisation.
data.pin_grant object
Villkorad: aktiv PIN-skyddad brevlådeskapning returnerar detta läsrätt; vanlig oskyddad skapning utelämnar den.
data.pin_grant.mailbox_id integer
Mailbox-ID som det villkorliga läsrättighetsbeviljandet är knutet till.
data.pin_grant.unlock_token string
Ogenomskinligt lästoken för X-Mailbox-Unlock med samma ägarkredit. Håll det privat och i minnet; en läsrätt beviljar inte radering.
data.pin_grant.scope string
Omfattningen läses för det villkorliga skapandetillståndet.
data.pin_grant.idle_timeout_seconds integer
Tillåten inaktiv tid för läsrättigheten, normalt 3600 sekunder.
data.pin_grant.absolute_timeout_seconds integer
Maximal livstid för läsrättigheten, normalt 86400 sekunder.
data.pin_grant.expires_at string
Aktuell läsbehörighetsutgång i ISO-8601-format.
data.pin_grant.absolute_expires_at string
Absolut läsbehörighetsutgång i ISO-8601-format. Säkerhetsändringar kan återkalla behörigheten tidigare.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Uppdatera / Byt brevlåda

Skapa eller välj en brevlåda på det nya användarnamnet och domänen efter att ha verifierat ägandet av den nuvarande brevlådan. Detta byter inte namn på den gamla brevlådan eller ändrar dess livslängd på plats. När destinationen skiljer sig, förblir den gamla brevlådan i historiken och kan pausas av begränsningar för aktiva brevlådor. Att återanvända din egen aktiva destination återapplicerar dess begärda livslängd eller standardinställning för planen.

Parametrar 9
Parameter Plats Typ Status Beskrivning
email path string obligatoriskt
Aktuell fullständig e-postadress för den ägda brevlådan som ska bytas. URL-koda varje sökvägssegment; koda ett plustecken som %2B.
username path string obligatoriskt
Nytt önskat användarnamn: 2 till 64 alfanumeriska tecken; föremål för anpassad användarnamnsbehörighet.
domain path string obligatoriskt
Nytt tillåtet domännamn.
lifetime body string valfri
tillåtna värden:
10m — 10 minuter 1h — 1 timme 2h — 2 Timmar 1d — 1 dag 1w — 1 Vecka 1m — 30 dagar 3m — 90 dagar 6m — 180 dagar 1y — 365 dagar unlimited — Obegränsat
Standard: Planens standardlivstid
pin_enabled body boolean valfri
Valfritt PIN-skydd för den nya brevlådan, när det tillåts av din plan. Det ändrar inte PIN-koden för en befintlig brevlåda.
Standard: false
pin body string valfri
Krävs när pin_enabled är true: en PIN på 6 till 8 siffror, skickad som en sträng för att bevara inledande nollor.
pin_confirmation body string valfri
Krävs när pin_enabled är true. Måste exakt matcha pin.
Idempotency-Key header string valfri
Krävs för PIN-skyddad skapning eller borttagning: en stabil nyckel på 16 till 128 tecken. Upprepa samma begäran med samma nyckel för att undvika duplicerat arbete.
X-Mailbox-Unlock header string valfri
Header, endast skyddade brevlådor: använd ett läs‑unlock_token. Gör först en POST pin och scope=read till PIN‑upplåsnings‑URL:en. Behåll din vanliga Bearer‑autentisering. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Använd en befintlig ägd brevlåda e-post i {email}. Valfri body-parameter: lifetime (tillåtna värden: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Utelämna livstid, eller lämna den tom, för att använda standardlivstiden för e‑post som är konfigurerad för din nuvarande månatliga/årliga plan. Skicka en tillåten livstid, t.ex. 1h, för att åsidosätta standardvärdet. Obegränsat används endast när det är konfigurerat som planens standard eller uttryckligen begärt och tillåtet. Kroppsparametrarna mailbox_lifetime och email_lifetime accepteras också; det första icke‑tomma värdet vinner i följande ordning: lifetime, mailbox_lifetime, email_lifetime. Ogiltiga eller otillåtna värden returnerar HTTP 422 istället för att tyst välja ett standardvärde.
Uppdatera ägd brevlåda
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'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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:19+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:19+00:00",
        "email_token": "encrypted-email-token"
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.id integer
Mailbox-ID. Genererade ID:n, adresser och token skiljer sig för varje brevlåda.
data.pin_protected boolean
Om denna brevlåda har PIN‑skydd. Ingen PIN eller PIN‑hash returneras.
data.email string
Genererad fullständig brevlådadress.
data.domain string
Domän för den genererade brevlådan.
data.provider string
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
data.expire_at string|null
Effektiv utgångstid som en ISO-8601 tidsstämpel, eller null för en obegränsad brevlåda.
data.expires_in_seconds number|null
Icke-negativa sekunder kvar när beräknat; bråkdelar av sekunder är möjliga. Null betyder obegränsat, inte noll.
data.mailbox_state string
Aktuell brevlådestatus: aktiv, pausad, utgången eller inaktiv.
data.receiving_enabled boolean
Om den här brevlådan för närvarande accepterar inkommande meddelanden.
data.message_count integer
Känt totalt meddelandeantal; det kan återspegla den senaste brevlådesynkroniseringen.
data.unread_message_count integer
Känd oläst meddelandeantal; det kan återspegla den senaste postlådesynkroniseringen.
data.last_message_received_at string|null
Senast kända mottagna meddelandetid i ISO-8601-format, eller null när otillgänglig.
data.message_count_synced_at string|null
Senaste synkroniseringstid för meddelandeantal i ISO-8601-format, eller null före synkronisering.
data.created_at string|null
Skapandetid för brevlåda i ISO-8601-format.
data.email_token string
Opak krypterad brevlådereferens. Den ersätter inte Bearer-autentisering, ägarkontroller eller PIN-auktorisation.
data.pin_grant object
Villkorad: aktiv PIN-skyddad brevlådeskapning returnerar detta läsrätt; vanlig oskyddad skapning utelämnar den.
data.pin_grant.mailbox_id integer
Mailbox-ID som det villkorliga läsrättighetsbeviljandet är knutet till.
data.pin_grant.unlock_token string
Ogenomskinligt lästoken för X-Mailbox-Unlock med samma ägarkredit. Håll det privat och i minnet; en läsrätt beviljar inte radering.
data.pin_grant.scope string
Omfattningen läses för det villkorliga skapandetillståndet.
data.pin_grant.idle_timeout_seconds integer
Tillåten inaktiv tid för läsrättigheten, normalt 3600 sekunder.
data.pin_grant.absolute_timeout_seconds integer
Maximal livstid för läsrättigheten, normalt 86400 sekunder.
data.pin_grant.expires_at string
Aktuell läsbehörighetsutgång i ISO-8601-format.
data.pin_grant.absolute_expires_at string
Absolut läsbehörighetsutgång i ISO-8601-format. Säkerhetsändringar kan återkalla behörigheten tidigare.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Radera brevlåda

Ta bort en ägd brevlåda och initiera dess meddelande- och filrengöring. Behållna brevlåderekord kan mjukt raderas internt; adressen är inte längre användbar via API:et.

Parametrar 3
Parameter Plats Typ Status Beskrivning
email path string obligatoriskt
Fullständig e‑postadress för den ägda brevlådan som ska tas bort. URL‑koda adressen; koda ett plustecken som %2B.
X-Mailbox-Unlock header string valfri
Rubrik, endast skyddade brevlådor: använd den engångsanvända delete unlock_token. Först POST pin, scope=delete och action/target_id som returneras av 423-svaret till PIN unlock URL. En lästoken kan inte radera. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string valfri
Krävs för PIN-skyddad skapning eller borttagning: en stabil nyckel på 16 till 128 tecken. Upprepa samma begäran med samma nyckel för att undvika duplicerat arbete.
Ta bort ägd brevlåda
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
message string
Resultat av borttagningen. En saknad resurs returnerar HTTP 404.

Gmail & Outlook-alias

Skapa högrenommerade Gmail- och Outlook/Hotmail-aliasbrevlådor.

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

Skapa Gmail‑alias

Skapa en ny Gmail-alias tillfällig brevlåda som ägs av den autentiserade användaren.

Parametrar 8
Parameter Plats Typ Status Beskrivning
mode body string valfri
Genereringsläge: auto, dot, plus eller plus_dot. Accepterar också gmail_alias_mode. Om stilval inte är tillåtet används auto.
Standard: auto
username body string valfri
Valfritt anpassat aliassuffix: 2 till 32 ASCII-bokstäver eller siffror, normaliserade till gemener; föremål för funktionsbehörighet. Accepterar också custom_username eller alias_username.
Standard: Automatiskt genererad
domain body string valfri
Använd slumpmässig, gmail.com eller googlemail.com; alias_domain accepteras också. Utelämning eller otillgänglig domänvalstillstånd använder slumpmässig.
Standard: random
lifetime body string valfri
tillåtna värden:
10m — 10 minuter 1h — 1 timme 2h — 2 Timmar 1d — 1 dag 1w — 1 Vecka 1m — 30 dagar 3m — 90 dagar 6m — 180 dagar 1y — 365 dagar unlimited — Obegränsat
Standard: Planens standardlivstid
pin_enabled body boolean valfri
Valfritt PIN-skydd för den nya brevlådan, när det tillåts av din plan. Det ändrar inte PIN-koden för en befintlig brevlåda.
Standard: false
pin body string valfri
Krävs när pin_enabled är true: en PIN på 6 till 8 siffror, skickad som en sträng för att bevara inledande nollor.
pin_confirmation body string valfri
Krävs när pin_enabled är true. Måste exakt matcha pin.
Idempotency-Key header string valfri
Krävs för PIN-skyddad skapning eller borttagning: en stabil nyckel på 16 till 128 tecken. Upprepa samma begäran med samma nyckel för att undvika duplicerat arbete.
Kräver att Gmail Alias API-behörigheten är aktiverad på din prenumerationsplan eller låst upp via ett API-kreditpaket. Valfria parametrar: mode (auto, dot, plus, plus_dot), username (anpassat alias användarnamn), domain (t.ex. gmail.com, googlemail.com), lifetime (tillåtna värden: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Utelämna livstid, eller lämna den tom, för att använda standardlivstiden för e‑post som är konfigurerad för din nuvarande månatliga/årliga plan. Skicka en tillåten livstid, t.ex. 1h, för att åsidosätta standardvärdet. Obegränsat används endast när det är konfigurerat som planens standard eller uttryckligen begärt och tillåtet. Kroppsparametrarna mailbox_lifetime och email_lifetime accepteras också; det första icke‑tomma värdet vinner i följande ordning: lifetime, mailbox_lifetime, email_lifetime. Ogiltiga eller otillåtna värden returnerar HTTP 422 istället för att tyst välja ett standardvärde.
Skapa Gmail-aliasbrevlåda
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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:19+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:19+00:00",
        "email_token": "encrypted-email-token"
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.id integer
Mailbox-ID. Genererade ID:n, adresser och token skiljer sig för varje brevlåda.
data.pin_protected boolean
Om denna brevlåda har PIN‑skydd. Ingen PIN eller PIN‑hash returneras.
data.email string
Genererad fullständig brevlådadress.
data.domain string
Domän för den genererade brevlådan.
data.provider string
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
data.expire_at string|null
Effektiv utgångstid som en ISO-8601 tidsstämpel, eller null för en obegränsad brevlåda.
data.expires_in_seconds number|null
Icke-negativa sekunder kvar när beräknat; bråkdelar av sekunder är möjliga. Null betyder obegränsat, inte noll.
data.mailbox_state string
Aktuell brevlådestatus: aktiv, pausad, utgången eller inaktiv.
data.receiving_enabled boolean
Om den här brevlådan för närvarande accepterar inkommande meddelanden.
data.message_count integer
Känt totalt meddelandeantal; det kan återspegla den senaste brevlådesynkroniseringen.
data.unread_message_count integer
Känd oläst meddelandeantal; det kan återspegla den senaste postlådesynkroniseringen.
data.last_message_received_at string|null
Senast kända mottagna meddelandetid i ISO-8601-format, eller null när otillgänglig.
data.message_count_synced_at string|null
Senaste synkroniseringstid för meddelandeantal i ISO-8601-format, eller null före synkronisering.
data.created_at string|null
Skapandetid för brevlåda i ISO-8601-format.
data.email_token string
Opak krypterad brevlådereferens. Den ersätter inte Bearer-autentisering, ägarkontroller eller PIN-auktorisation.
data.pin_grant object
Villkorad: aktiv PIN-skyddad brevlådeskapning returnerar detta läsrätt; vanlig oskyddad skapning utelämnar den.
data.pin_grant.mailbox_id integer
Mailbox-ID som det villkorliga läsrättighetsbeviljandet är knutet till.
data.pin_grant.unlock_token string
Ogenomskinligt lästoken för X-Mailbox-Unlock med samma ägarkredit. Håll det privat och i minnet; en läsrätt beviljar inte radering.
data.pin_grant.scope string
Omfattningen läses för det villkorliga skapandetillståndet.
data.pin_grant.idle_timeout_seconds integer
Tillåten inaktiv tid för läsrättigheten, normalt 3600 sekunder.
data.pin_grant.absolute_timeout_seconds integer
Maximal livstid för läsrättigheten, normalt 86400 sekunder.
data.pin_grant.expires_at string
Aktuell läsbehörighetsutgång i ISO-8601-format.
data.pin_grant.absolute_expires_at string
Absolut läsbehörighetsutgång i ISO-8601-format. Säkerhetsändringar kan återkalla behörigheten tidigare.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Outlook-aliasdomäner

Hämta aktiva Outlook/Hotmail-aliasdomäner som är tillgängliga för att skapa brevlåda.

Kräver att Outlook Alias API-behörigheten är aktiverad på din prenumerationsplan eller låst upp via ett API-kreditpaket. Anger om specifikt domänval är upplåst i din plan.
Hämta Outlook-aliasdomäner
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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
            }
        ]
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.domains array
Aktiva Outlook/Hotmail-domäner; en tom array är giltig.
data.domains[].domain string
Tillgängligt domännamn.
data.domains[].type string
Läsbar leverantörsetikett.
data.domains[].selectable boolean
Om ditt konto kan uttryckligen välja den här domänen.
data.domains[].locked boolean
Om explicit domänval är låst för ditt konto.
data.domains[].disabled_reason string|null
Anledning till att domänval är låst, eller null när det är valbart.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Skapa Outlook-alias

Skapa en ny Outlook / Hotmail-alias tillfällig brevlåda som ägs av den autentiserade användaren.

Parametrar 7
Parameter Plats Typ Status Beskrivning
domain body string valfri
Använd slumpmässig eller en domän från GET /outlook-alias/domains; outlook_alias_domain accepteras också. Utan urvalstillstånd används slumpmässig.
Standard: Slumpmässig tillgänglig domän
username body string valfri
Valfritt anpassat aliassuffix: 2 till 32 ASCII-bokstäver eller siffror, normaliserade till gemener; föremål för funktionsbehörighet. Accepterar också custom_username eller alias_username.
Standard: Automatiskt genererad
lifetime body string valfri
tillåtna värden:
10m — 10 minuter 1h — 1 timme 2h — 2 Timmar 1d — 1 dag 1w — 1 Vecka 1m — 30 dagar 3m — 90 dagar 6m — 180 dagar 1y — 365 dagar unlimited — Obegränsat
Standard: Planens standardlivstid
pin_enabled body boolean valfri
Valfritt PIN-skydd för den nya brevlådan, när det tillåts av din plan. Det ändrar inte PIN-koden för en befintlig brevlåda.
Standard: false
pin body string valfri
Krävs när pin_enabled är true: en PIN på 6 till 8 siffror, skickad som en sträng för att bevara inledande nollor.
pin_confirmation body string valfri
Krävs när pin_enabled är true. Måste exakt matcha pin.
Idempotency-Key header string valfri
Krävs för PIN-skyddad skapning eller borttagning: en stabil nyckel på 16 till 128 tecken. Upprepa samma begäran med samma nyckel för att undvika duplicerat arbete.
Kräver att Outlook Alias API-behörigheten är aktiverad på din prenumerationsplan eller låst upp via ett API-kreditpaket. Valfria parametrar: domain (t.ex. outlook.com, hotmail.com), username (anpassat alias användarnamn), lifetime (tillåtna värden: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Utelämna livstid, eller lämna den tom, för att använda standardlivstiden för e‑post som är konfigurerad för din nuvarande månatliga/årliga plan. Skicka en tillåten livstid, t.ex. 1h, för att åsidosätta standardvärdet. Obegränsat används endast när det är konfigurerat som planens standard eller uttryckligen begärt och tillåtet. Kroppsparametrarna mailbox_lifetime och email_lifetime accepteras också; det första icke‑tomma värdet vinner i följande ordning: lifetime, mailbox_lifetime, email_lifetime. Ogiltiga eller otillåtna värden returnerar HTTP 422 istället för att tyst välja ett standardvärde.
Skapa Outlook-aliasbrevlåda
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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:19+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:19+00:00",
        "email_token": "encrypted-email-token"
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.id integer
Mailbox-ID. Genererade ID:n, adresser och token skiljer sig för varje brevlåda.
data.pin_protected boolean
Om denna brevlåda har PIN‑skydd. Ingen PIN eller PIN‑hash returneras.
data.email string
Genererad fullständig brevlådadress.
data.domain string
Domän för den genererade brevlådan.
data.provider string
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
data.expire_at string|null
Effektiv utgångstid som en ISO-8601 tidsstämpel, eller null för en obegränsad brevlåda.
data.expires_in_seconds number|null
Icke-negativa sekunder kvar när beräknat; bråkdelar av sekunder är möjliga. Null betyder obegränsat, inte noll.
data.mailbox_state string
Aktuell brevlådestatus: aktiv, pausad, utgången eller inaktiv.
data.receiving_enabled boolean
Om den här brevlådan för närvarande accepterar inkommande meddelanden.
data.message_count integer
Känt totalt meddelandeantal; det kan återspegla den senaste brevlådesynkroniseringen.
data.unread_message_count integer
Känd oläst meddelandeantal; det kan återspegla den senaste postlådesynkroniseringen.
data.last_message_received_at string|null
Senast kända mottagna meddelandetid i ISO-8601-format, eller null när otillgänglig.
data.message_count_synced_at string|null
Senaste synkroniseringstid för meddelandeantal i ISO-8601-format, eller null före synkronisering.
data.created_at string|null
Skapandetid för brevlåda i ISO-8601-format.
data.email_token string
Opak krypterad brevlådereferens. Den ersätter inte Bearer-autentisering, ägarkontroller eller PIN-auktorisation.
data.pin_grant object
Villkorad: aktiv PIN-skyddad brevlådeskapning returnerar detta läsrätt; vanlig oskyddad skapning utelämnar den.
data.pin_grant.mailbox_id integer
Mailbox-ID som det villkorliga läsrättighetsbeviljandet är knutet till.
data.pin_grant.unlock_token string
Ogenomskinligt lästoken för X-Mailbox-Unlock med samma ägarkredit. Håll det privat och i minnet; en läsrätt beviljar inte radering.
data.pin_grant.scope string
Omfattningen läses för det villkorliga skapandetillståndet.
data.pin_grant.idle_timeout_seconds integer
Tillåten inaktiv tid för läsrättigheten, normalt 3600 sekunder.
data.pin_grant.absolute_timeout_seconds integer
Maximal livstid för läsrättigheten, normalt 86400 sekunder.
data.pin_grant.expires_at string
Aktuell läsbehörighetsutgång i ISO-8601-format.
data.pin_grant.absolute_expires_at string
Absolut läsbehörighetsutgång i ISO-8601-format. Säkerhetsändringar kan återkalla behörigheten tidigare.

Meddelanden & bilagor

Hämta inkommande inkorgar, läs fullständiga HTML-/textmeddelanden och strömma bilagor.

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

Lista meddelanden i brevlådan

Hämta tillgängliga meddelandesammanfattningar och brevlådemetadata. Standardgenomsökningar av inkorgen returnerar ett nyligen batch på upp till 25 meddelanden; detta är inte en paginerad fullhistorik-endpoint. Använd GET /messages/{messageId} för fullständiga meddelanden och bilagor.

Parametrar 2
Parameter Plats Typ Status Beskrivning
email query string obligatoriskt
Full e-postadress för den ägda brevlådan att läsa meddelanden från. URL-koda frågevärdet; koda ett plustecken som %2B.
X-Mailbox-Unlock header string valfri
Header, endast skyddade brevlådor: använd ett läs‑unlock_token. Gör först en POST pin och scope=read till PIN‑upplåsnings‑URL:en. Behåll din vanliga Bearer‑autentisering. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
E‑posten måste tillhöra ditt konto. Standard‑ och Gmail‑sammanfattningar innehåller OTP‑ och verification‑link‑fält; Outlook inkluderar också from_name, snippet, received_at och has_attachments. Leverantörssynkronisering och cachning kan fördröja nya meddelanden och räknare.
Läs brevlådemeddelanden
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'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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:19",
            "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:19+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:19+00:00",
    "message_count_synced_at": "2026-11-19T02:18:19+00:00"
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
mailbox string
Postlådeadress vars meddelanden begärdes.
email_token string
Ogenomskinlig krypterad brevlådsreferens; normal autentisering krävs fortfarande.
mailbox_provider string
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
messages array
Meddelandesammanfattningar. En tom inkorg returnerar en tom array; hämta ett enskilt meddelande för dess innehåll och bilagor.
expire_at string|null
Effektiv utgångstid som en ISO-8601 tidsstämpel, eller null för en obegränsad brevlåda.
expires_in_seconds number|null
Icke-negativa sekunder kvar när beräknat; bråkdelar av sekunder är möjliga. Null betyder obegränsat, inte noll.
mailbox_state string
Aktuell brevlådestatus: aktiv, pausad, utgången eller inaktiv.
receiving_enabled boolean
Om den här brevlådan för närvarande accepterar inkommande meddelanden.
message_count integer
Känt totalt meddelandeantal; det kan återspegla den senaste brevlådesynkroniseringen.
unread_message_count integer
Känd oläst meddelandeantal; det kan återspegla den senaste postlådesynkroniseringen.
last_message_received_at string|null
Senast kända mottagna meddelandetid i ISO-8601-format, eller null när otillgänglig.
message_count_synced_at string|null
Senaste synkroniseringstid för meddelandeantal i ISO-8601-format, eller null före synkronisering.
mailbox_limit.limit integer
Aktiv brevlådesgräns för denna leverantör; -1 betyder obegränsat.
mailbox_limit.limit_label string
Visningsetikett för postlådesgränsen.
mailbox_limit.active_count integer
Antal aktiva brevlådor för denna leverantör.
mailbox_limit.paused_count integer
Antal pausade brevlådor för denna leverantör.
mailbox_limit.paused_mailboxes array<string>
Adresser pausade på grund av postlådesgränsen.
mailbox_limit.remaining integer
Återstående aktiva brevlådeslots; -1 betyder obegränsat. Detta är inte API-förfrågningskvot.
mailbox_limit.remaining_label string
Visningsetikett för återstående brevlådeslots.
mailbox_limit.reached boolean
Om den aktiva brevlådesgränsen har nåtts.
mailbox_limit.blocked boolean
Om den aktiva brevlådesgränsen är noll.
mailbox_limit.provider string|null
Leverantör som brevlådesbegränsningen gäller för.
messages[].id string
Opakt meddelande-ID som används av enskilda meddelande-, raderings- och bilagaändpunkter.
messages[].is_seen boolean
Om meddelandet är markerat som läst.
messages[].subject string
Meddelandets ämne.
messages[].from string
Avsändarens visningsnamn eller adress.
messages[].from_email string
Avsändarens e‑postadress.
messages[].receivedAt string
Mottagen tid i applikationens tidszon, formaterad som YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Detekterad engångskod när den är tillgänglig och tillåten; annars null.
messages[].otp_locked boolean
Om en upptäckt engångskod är dold av funktionsbehörigheter.
messages[].verification_link string|null
Upptäckt verifierings-URL när tillgänglig och tillåten; annars null.
messages[].verification_link_locked boolean
Om en upptäckt verifieringslänk är dold av funktionsbehörigheter.
messages[].from_name string|null
Outlook‑sammanfattningsfält: ursprungligt avsändarnamn. Saknas i Standard‑ och Gmail‑sammanfattningar.
messages[].snippet string|null
Outlook‑sammanfattningsfält: kort meddelandeförhandsgranskning.
messages[].received_at string|null
Outlook‑sammanfattningsfält: ISO‑8601 mottagningstid, när den är känd.
messages[].has_attachments boolean
Outlook-sammanfattningsfält: om bifogad metadata finns. Nedladdningsmöjlighet kontrolleras separat.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Hämta ett meddelande

Hämta ett ägt meddelande med dess ogenomskinliga meddelande-ID. Returnerar kroppformat och metadata för bilagor. Kropps-fält beror på meddelandeformatet; Outlook lägger till leverantörsspecifika fält som listas nedan.

Parametrar 2
Parameter Plats Typ Status Beskrivning
messageId path string obligatoriskt
Unikt meddelande-ID som returneras i meddelandelistan.
X-Mailbox-Unlock header string valfri
Header, endast skyddade brevlådor: använd ett läs‑unlock_token. Gör först en POST pin och scope=read till PIN‑upplåsnings‑URL:en. Behåll din vanliga Bearer‑autentisering. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Läs ett meddelande
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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:19",
        "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"
            }
        ]
    }
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
data.id string
Ogenomskinligt meddelande-ID.
data.is_seen boolean
Meddelandets läsläge. Läsning kan markera det som sett; cachad data kan återspegla ett tidigare tillstånd.
data.subject string
Meddelandets ämne.
data.from string
Avsändarens visningsnamn eller adress.
data.from_email string
Avsändarens e‑postadress.
data.to string
Mottagarens brevlådadress.
data.mailbox_provider string
Brevlådesleverantör: standard, gmail_alias eller outlook_alias.
data.receivedAt string
Mottagen tid i applikationens tidszon, formaterad som YYYY-MM-DD HH:mm:ss.
data.html boolean
Om meddelandet har en HTML‑kropp.
data.html_content string
HTML‑kropp när den finns. Standardmeddelanden utan HTML kan utelämna detta fält. Behandla meddelandeinnehållet som opålitligt.
data.text_content string
Textkropp när den finns; Standardmeddelanden kan innehålla escapad text i ett pre-element eller utelämna detta fält.
data.content string
Föredragen kropp för visning, normalt HTML när tillgänglig.
data.attachments array
Bilagans metadata, eller en tom array. Nedladdningar kräver normal autentisering och tillämplig PIN-auktorisation.
data.attachments[].name string
Filnamn att URL-koda som ett enda sökvägssegment vid nedladdning.
data.attachments[].size integer
Bilagestorlek i byte.
data.attachments[].url string
Autentiserad användar‑API‑nedladdnings‑URL har lagts till bilagor med ett filnamn. En URL garanterar inte att den lokala filen är tillgänglig.
data.attachments[].extension string
Standard/Gmail-metadatafält: filändelse när den anges.
data.attachments[].id string
Outlook-metadatafält: leverantörens bilaga-ID.
data.attachments[].content_type string
Outlook-metadatafält: MIME‑innehållstyp.
data.from_name string|null
Outlook-detaljfält: ursprungligt avsändarnamn.
data.to_email string|null
Outlook-detaljfält: original mottagaradress.
data.received_at string|null
Outlook-detaljfält: ISO-8601 mottagen tid.
data.has_html boolean
Outlook-detaljfält: om en HTML‑kropp finns.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Radera meddelande

Ta bort ett enskilt ägt meddelande.

Parametrar 3
Parameter Plats Typ Status Beskrivning
messageId path string obligatoriskt
Unik meddelande-ID-sträng för att permanent radera.
X-Mailbox-Unlock header string valfri
Rubrik, endast skyddade brevlådor: använd den engångsanvända delete unlock_token. Först POST pin, scope=delete och action/target_id som returneras av 423-svaret till PIN unlock URL. En lästoken kan inte radera. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string valfri
Krävs för PIN-skyddad skapning eller borttagning: en stabil nyckel på 16 till 128 tecken. Upprepa samma begäran med samma nyckel för att undvika duplicerat arbete.
Ta bort ett meddelande
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Svarfält
Fält Typ Beskrivning
status boolean
Om operationen lyckades.
message string
Resultat av borttagningen. En saknad resurs returnerar HTTP 404.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Ladda ner bilaga

Ladda ner en bilaga från ett meddelande som ägs.

Parametrar 3
Parameter Plats Typ Status Beskrivning
messageId path string obligatoriskt
ID för meddelandet som innehåller filen.
filename path string obligatoriskt
Filnamn och filändelse för bilagan att ladda ner.
X-Mailbox-Unlock header string valfri
Header, endast skyddade brevlådor: använd ett läs‑unlock_token. Gör först en POST pin och scope=read till PIN‑upplåsnings‑URL:en. Behåll din vanliga Bearer‑autentisering. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Lyckad begäran returnerar filbytes, inte JSON. För stora filer returnerar HTTP 403; saknade eller otillgängliga lokala filer returnerar HTTP 404. URL-koda filnamnet som ett enda sökvägssegment. Endast bilagans metadata garanterar inte nedladdningsmöjlighet.
Ladda ner en bilaga
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
Nedladdningsbeteende Denna slutpunkt returnerar den begärda filen direkt istället för ett JSON-objekt.
Svarfält
Fält Typ Beskrivning
Content-Disposition header
Ett lyckat svar laddar ner det begärda filnamnet.
body binary
Filbytes vid framgång, inte JSON. Fel returnerar JSON med en icke-2xx-status.

Hastighetsgränser och kvoter

Övervaka realtidsförfrågningsbudgetar, hastighetsgränser och kontokvoter utan att förbruka krediter.

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

Hastighetsgräns & Kvot

Kontrollera din nuvarande hastighetsgräns och kvotstatus utan att förbruka någon API-användning. Denna endpoint är kvotfri och drar inte av månatliga API-krediter (missbruksskyddslimit: 60 förfrågningar/min).

X-RateLimit-* beskriver den angivna begäransbudgeten; X-Quota-* beskriver månatlig och köpt kapacitet när den är tillgänglig. X-Mailbox-RateLimit-* rapporterar den separata budgeten för brevlåds‑skapande/‑uppdatering. Ett avslag som endast gäller brevlådan använder brevlådeskop och dess egen återförsöksperiod. Avslag med minutgräns kan utelämna kvotinformation. Retry-After inkluderas endast för ett tidsbestämt återförsök; inaktiverad åtkomst kan kräva ett konto‑byte. I detta framgångsrika statussvar beskriver data.limit, data.remaining och data.reset kontots minutbudget, inte spenderbara krediter. data.quota-objektet beskriver månatligt tilldelat belopp, kreditbalanser och användning. De befintliga fälten data.monthly_limit, data.monthly_remaining och data.purchased_credits förblir alias för motsvarande kvotfält. En lyckad statuskontroll ger inte behörighet för en annan API‑operation. Operationer kräver fortfarande aktiverad åtkomst, tillgänglig kvot och godkännande genom alla tillämpliga begränsningar. Kvotsnapshotet lovar inte kapacitet som redan är reserverad av en pågående begäran.
Kontrollera status för hastighetsgräns
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Illustrativt svar med syntetiska data. ID:n, adresser, token, tidsstämplar, planbegränsningar och räknare varierar. Exempel på livstider åsidosätter inte ditt planstandard. Svarsfältbeskrivningar identifierar nullbara och leverantörsspecifika fält.

Exempel på svar
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"
        }
    }
}
Svarfält
Fält Typ Beskrivning
data.limit integer|string
Konto förfrågningar-per-minut-gräns. Strängen unlimited betecknar en obegränsad minutbudget; detta är oberoende av den månatliga kvoten.
data.remaining integer|string
Återstående kontominutbudgetplatser, eller strängen unlimited. Ett positivt värde betyder inte att API-krediter återstår.
data.reset integer
Sekunder för kontots minutfönster, inte den månatliga kvotåterställningen. Inaktiverade eller obegränsade minutbudgetar kan behålla ett nominellt värde på 60 sekunder; detta garanterar inte åtkomst efter väntan.
data.plan string
Aktuell planetikett. Det läsbara plannamnet tillhandahålls separat i data.quota.plan_name.
data.quota.enabled boolean
Om global och plan/kredit API-åtkomst är aktiverad. Detta indikerar inte återstående kapacitet eller ersätter användarens API‑växel.
data.quota.user_api_status boolean
Om användaren har aktiverat sin User API‑omkopplare. Operationer kräver denna omkopplare samt aktiverad åtkomst och tillgänglig kapacitet.
data.quota.plan_name string
Läsbart namn på den aktuella planen.
data.quota.period string
Kalendermånadens användningsperiod i formatet ÅÅÅÅ-MM, med applikationens tidszon; inte nödvändigtvis abonnemangets faktureringsperiod.
data.quota.base_limit integer
Grundläggande månatligt planutrymme. Ett värde på -1 betyder obegränsat.
data.quota.extra_requests integer
Ytterligare månatligt tillägg beviljat för den aktuella användningsperioden; separat från köpta krediter.
data.quota.monthly_limit integer
Grundtilldelning plus extra förfrågningar för aktuell period. Ett värde på -1 betyder obegränsat. Köpta krediter är inte inkluderade.
data.quota.monthly_remaining integer|null
Återstående begränsade månatliga tilldelning, eller null när den månatliga kvoten är obegränsad. Null får inte tolkas som noll.
data.quota.used integer
Lyckade, räknade API‑operationer under den aktuella användningsperioden, inklusive operationer som använder krediter. Statuskontroller ökar inte detta värde.
data.quota.purchased_credits integer
Aktuell kreditbalans, inklusive bonuskrediter för aktiv plan. Bonuskrediter får inte läggas till detta saldo en andra gång.
data.quota.bonus_credits integer
Aktiv planbonusdel av kreditbalansen; en uppdelning av purchased_credits, inte ytterligare kapacitet.
data.quota.direct_purchased_credits integer
Kreditbalans exklusive den aktiva planbonusdelen. Detta värde plus bonus_credits är lika med purchased_credits.
data.quota.remaining integer|null
Månatligt återstående tilldelning plus den aktuella kreditbalansen, utan att dubbelräkna bonusar. Null betyder obegränsad månatlig kvot. Individuella funktionsbehörigheter och andra begäransgränser gäller fortfarande.
data.quota.unlimited boolean
Om den månatliga kvoten är obegränsad. Detta gör inte kontots minutbudget eller andra funktionsgränser obegränsade.
data.quota.usage_percent integer
Dashboard-kompatibel avrundad procentsats från 0 till 100: använt delat med använt plus återstående, multiplicerat med 100. Den inkluderar tillgänglig kreditkapacitet, så påfyllning kan sänka procentsatsen. Den är 0 för obegränsad kvot eller en pool med noll storlek; den är inte minutens hastighetsgränsprocentsats eller ett åtkomstbeslut.
data.quota.reset_at string
ISO-8601-tidsstämpel med tidszonsförskjutning för nästa kalendermånadens kvotåterställning. Detta är inte prenumerationens utgångsdatum, och den månatliga återställningen fyller inte på köpta krediter.
status string
Den bokstavliga framgången för denna statusändpunkt. Andra framgångsrika brevlådsändpunkter använder boolean true.
data.monthly_limit integer
Kompatibilitetsalias för motsvarande data.quota-fält; lägg inte till det igen när du beräknar saldon.
data.monthly_remaining integer|null
Kompatibilitetsalias för motsvarande data.quota-fält; lägg inte till det igen när du beräknar saldon.
data.purchased_credits integer
Kompatibilitetsalias för motsvarande data.quota-fält; lägg inte till det igen när du beräknar saldon.

Brevlåda PIN-skydd

Ange PIN för att fortsätta. Din brevlåda förblir olåst så länge den är aktuell i den här webbplatsens session.

Accepterar du cookies?

Vi använder cookies för att förbättra din webbupplevelse. Genom att använda denna webbplats ger du ditt samtycke till vår cookiepolicy.

Mer