Dokumentacja API TempMail

REST API v1 i Webhooki

TempMailg Dokumentacja API dla programistów

Użyj tej dokumentacji, aby wygenerować swój osobisty klucz API, połączyć dedykowany host API użytkownika, odczytać wiadomości z skrzynki pocztowej, zarządzać skrzynkami pocztowymi należącymi do użytkownika i zintegrować Temp Mail ze swoimi aplikacjami lub automatyzacjami.

Uwierzytelnianie tokenem Bearer Webhooki w czasie rzeczywistym Aliasy Gmail i Outlook Odpowiedzi JSON
Podstawowy adres URL API użytkownika HTTPS
Format żądania Używaj swojego klucza API tylko w nagłówku Autoryzacji Bearer i zachowuj czyste adresy URL punktów końcowych.

Zarządzanie skrzynką pocztową

Pobierz dozwolone domeny, utwórz lub zmień skrzynki pocztowe, wybierz dozwolone okresy ważności i usuń posiadane adresy.

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

Lista dozwolonych domen

Wyświetl dostępne domeny do tworzenia tymczasowych e‑maili. Filtruj według typu, aby zobaczyć tylko darmowe, premium lub niestandardowe domeny obsługiwane w ramach Twojego planu subskrypcyjnego.

Parametry 1
Parametr Lokalizacja Typ Status Opis
type query string opcjonalny
Filtr poziomu domeny. Pominięcie używa wszystkich, gdy dostęp do domen premium jest włączony, w przeciwnym razie darmowych. Rozpoznane wartości: free, basic, pro, premium, custom, ultimate, all
Domyślnie: Zależny od konta
Pobierz dozwolone domeny
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "requested_type": "free",
        "plan": "pro",
        "plan_name": "Pro Plan",
        "allowed_types": [
            "free",
            "basic",
            "pro",
            "premium",
            "custom",
            "ultimate",
            "all"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.requested_type string
Zastosowano filtr domeny.
data.plan string
Aktualny znacznik planu.
data.plan_name string
Czytelna nazwa bieżącego planu.
data.allowed_types array<string>
Filtry domen dostępne dla tego konta. Rozpoznany filtr może nadal być zabroniony w Twoim planie.
data.domains array
Dostępne domeny po filtrowaniu; pusta tablica jest prawidłowa.
data.domains[].domain string
Wybieralna nazwa domeny.
data.domains[].type string
Etykieta poziomu domeny odczytywalnej.
data.domains[].custom boolean
Czy jest to niestandardowa domena.
POST https://v1.tempmailg.com/api/emails
#

Utwórz tymczasową skrzynkę pocztową

Utwórz własną tymczasową skrzynkę pocztową. Pomiń nazwę użytkownika i domenę, aby wygenerować losowo, lub podaj dozwoloną niestandardową nazwę użytkownika i dozwoloną domenę. Parametr provider może wybrać generowanie aliasu Gmail lub Outlook.

Parametry 8
Parametr Lokalizacja Typ Status Opis
username body string opcjonalny
Opcjonalna niestandardowa nazwa użytkownika: od 2 do 64 znaków ASCII, litery, cyfry, kropki, podkreślenia lub myślniki. Wymaga uprawnienia planu; akceptowane jest również custom_username.
Domyślnie: Wygenerowane losowo
domain body string opcjonalny
Jedna z dozwolonych domen zwróconych przez GET /domains. Pominięcie wybiera losową dozwoloną domenę.
Domyślnie: Losowo dozwolona domena
lifetime body string opcjonalny
dozwolone wartości:
10m — 10 minut 1h — 1 Godzina 2h — 2 godziny 1d — 1 dzień 1w — 1 Tydzień 1m — 30 dni 3m — 90 dni 6m — 180 dni 1y — 365 dni unlimited — Nielimitowane
Domyślnie: Domyślny okres życia planu
provider body string opcjonalny
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
Domyślnie: standard
pin_enabled body boolean opcjonalny
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie: false
pin body string opcjonalny
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
pin_confirmation body string opcjonalny
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
Idempotency-Key header string opcjonalny
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
Opcjonalne parametry ciała: username (niestandardowa nazwa użytkownika, jeśli jest dozwolona w planie), domain (dozwolona domena, np. example.com), lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.
Utwórz skrzynkę pocztową
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2301,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-20T02:17:52+00:00",
        "expires_in_seconds": 86399.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:52+00:00",
        "email_token": "encrypted-email-token"
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.id integer
Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki.
data.pin_protected boolean
Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany.
data.email string
Wygenerowano pełny adres skrzynki pocztowej.
data.domain string
Domena generowanej skrzynki pocztowej.
data.provider string
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
data.expire_at string|null
Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej.
data.expires_in_seconds number|null
Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero.
data.mailbox_state string
Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny.
data.receiving_enabled boolean
Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości?
data.message_count integer
Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.unread_message_count integer
Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.last_message_received_at string|null
Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny.
data.message_count_synced_at string|null
Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją.
data.created_at string|null
Czas utworzenia skrzynki pocztowej w formacie ISO-8601.
data.email_token string
Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN.
data.pin_grant object
Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je.
data.pin_grant.mailbox_id integer
Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt.
data.pin_grant.unlock_token string
Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia.
data.pin_grant.scope string
Zakres odczytu dla warunkowego przyznania tworzenia.
data.pin_grant.idle_timeout_seconds integer
Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund.
data.pin_grant.absolute_timeout_seconds integer
Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund.
data.pin_grant.expires_at string
Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601.
data.pin_grant.absolute_expires_at string
Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Aktualizuj / Zmień skrzynkę pocztową

Utwórz lub wybierz skrzynkę pocztową pod nową nazwą użytkownika i domeną po zweryfikowaniu własności bieżącej skrzynki. To nie zmienia nazwy starej skrzynki ani nie modyfikuje jej okresu ważności w miejscu. Gdy docelowy adres różni się, stara skrzynka pozostaje w historii i może być wstrzymana przez limity aktywnych skrzynek. Ponowne użycie własnego aktywnego docelowego adresu przywraca żądany okres ważności lub domyślny plan.

Parametry 9
Parametr Lokalizacja Typ Status Opis
email path string wymagane
Aktualny pełny adres e-mail posiadanej skrzynki pocztowej do przełączenia. URL-encode każdy segment ścieżki; zakoduj znak plus jako %2B.
username path string wymagane
Nowa żądana nazwa użytkownika: od 2 do 64 znaków alfanumerycznych; podlega uprawnieniom do niestandardowych nazw użytkowników.
domain path string wymagane
Nowa dozwolona nazwa domeny.
lifetime body string opcjonalny
dozwolone wartości:
10m — 10 minut 1h — 1 Godzina 2h — 2 godziny 1d — 1 dzień 1w — 1 Tydzień 1m — 30 dni 3m — 90 dni 6m — 180 dni 1y — 365 dni unlimited — Nielimitowane
Domyślnie: Domyślny okres życia planu
pin_enabled body boolean opcjonalny
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie: false
pin body string opcjonalny
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
pin_confirmation body string opcjonalny
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
Idempotency-Key header string opcjonalny
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
X-Mailbox-Unlock header string opcjonalny
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie Bearer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Użyj istniejącej skrzynki pocztowej należącej do użytkownika w {email}. Opcjonalny parametr ciała: lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.
Zaktualizuj skrzynkę pocztową należącą do użytkownika
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2302,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-19T02:27:52+00:00",
        "expires_in_seconds": 599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:52+00:00",
        "email_token": "encrypted-email-token"
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.id integer
Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki.
data.pin_protected boolean
Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany.
data.email string
Wygenerowano pełny adres skrzynki pocztowej.
data.domain string
Domena generowanej skrzynki pocztowej.
data.provider string
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
data.expire_at string|null
Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej.
data.expires_in_seconds number|null
Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero.
data.mailbox_state string
Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny.
data.receiving_enabled boolean
Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości?
data.message_count integer
Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.unread_message_count integer
Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.last_message_received_at string|null
Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny.
data.message_count_synced_at string|null
Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją.
data.created_at string|null
Czas utworzenia skrzynki pocztowej w formacie ISO-8601.
data.email_token string
Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN.
data.pin_grant object
Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je.
data.pin_grant.mailbox_id integer
Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt.
data.pin_grant.unlock_token string
Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia.
data.pin_grant.scope string
Zakres odczytu dla warunkowego przyznania tworzenia.
data.pin_grant.idle_timeout_seconds integer
Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund.
data.pin_grant.absolute_timeout_seconds integer
Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund.
data.pin_grant.expires_at string
Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601.
data.pin_grant.absolute_expires_at string
Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Usuń skrzynkę pocztową

Usuń posiadaną skrzynkę pocztową i wywołaj jej czyszczenie wiadomości i plików. Zachowane rekordy skrzynki mogą być wewnętrznie miękko usunięte; adres nie jest już dostępny przez API.

Parametry 3
Parametr Lokalizacja Typ Status Opis
email path string wymagane
Pełny adres e‑mail skrzynki pocztowej, którą należy usunąć. Zakoduj adres w formacie URL; znak plusa zakoduj jako %2B.
X-Mailbox-Unlock header string opcjonalny
Nagłówek, tylko chronione skrzynki pocztowe: użyj jednorazowego tokenu unlock_token do usuwania. Najpierw wyślij POST pin, scope=delete i action/target_id zwrócone w odpowiedzi 423 na URL odblokowujący PIN. Token odczytu nie może usuwać. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string opcjonalny
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
Usuń skrzynkę pocztową należącą do użytkownika
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
message string
Wynik usunięcia. Brakujący zasób zwraca HTTP 404.

Aliasy Gmail i Outlook

Generuj skrzynki aliasowe Gmail i Outlook/Hotmail o wysokiej reputacji.

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

Utwórz alias Gmail

Utwórz nową tymczasową skrzynkę aliasu Gmail, będącą własnością uwierzytelnionego użytkownika.

Parametry 8
Parametr Lokalizacja Typ Status Opis
mode body string opcjonalny
Tryb generowania: auto, dot, plus lub plus_dot. Akceptuje także gmail_alias_mode. Jeśli wybór stylu nie jest dozwolony, używany jest auto.
Domyślnie: auto
username body string opcjonalny
Opcjonalny niestandardowy przyrostek aliasu: od 2 do 32 znaków ASCII (litery lub cyfry), znormalizowany do małych liter; podlega uprawnieniom funkcji. Akceptuje także custom_username lub alias_username.
Domyślnie: Automatycznie wygenerowane
domain body string opcjonalny
Użyj losowego, gmail.com lub googlemail.com; alias_domain jest również akceptowany. Pominięcie lub brak uprawnienia do wyboru domeny używa losowego.
Domyślnie: random
lifetime body string opcjonalny
dozwolone wartości:
10m — 10 minut 1h — 1 Godzina 2h — 2 godziny 1d — 1 dzień 1w — 1 Tydzień 1m — 30 dni 3m — 90 dni 6m — 180 dni 1y — 365 dni unlimited — Nielimitowane
Domyślnie: Domyślny okres życia planu
pin_enabled body boolean opcjonalny
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie: false
pin body string opcjonalny
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
pin_confirmation body string opcjonalny
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
Idempotency-Key header string opcjonalny
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
Wymaga włączenia uprawnienia Gmail Alias API w planie subskrypcji lub odblokowania za pomocą pakietu kredytów API. Opcjonalne parametry: mode (auto, dot, plus, plus_dot), username (niestandardowa nazwa aliasu użytkownika), domain (np. gmail.com, googlemail.com), lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.
Utwórz alias skrzynki Gmail
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2305,
        "pin_protected": false,
        "email": "example+alias123@gmail.com",
        "domain": "gmail.com",
        "provider": "gmail_alias",
        "expire_at": "2026-11-19T03:17:52+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:52+00:00",
        "email_token": "encrypted-email-token"
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.id integer
Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki.
data.pin_protected boolean
Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany.
data.email string
Wygenerowano pełny adres skrzynki pocztowej.
data.domain string
Domena generowanej skrzynki pocztowej.
data.provider string
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
data.expire_at string|null
Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej.
data.expires_in_seconds number|null
Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero.
data.mailbox_state string
Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny.
data.receiving_enabled boolean
Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości?
data.message_count integer
Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.unread_message_count integer
Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.last_message_received_at string|null
Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny.
data.message_count_synced_at string|null
Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją.
data.created_at string|null
Czas utworzenia skrzynki pocztowej w formacie ISO-8601.
data.email_token string
Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN.
data.pin_grant object
Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je.
data.pin_grant.mailbox_id integer
Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt.
data.pin_grant.unlock_token string
Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia.
data.pin_grant.scope string
Zakres odczytu dla warunkowego przyznania tworzenia.
data.pin_grant.idle_timeout_seconds integer
Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund.
data.pin_grant.absolute_timeout_seconds integer
Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund.
data.pin_grant.expires_at string
Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601.
data.pin_grant.absolute_expires_at string
Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Domeny aliasów Outlook

Pobierz aktywne domeny aliasów Outlook / Hotmail dostępne do generowania skrzynki pocztowej.

Wymaga włączenia uprawnienia Outlook Alias API w Twoim planie subskrypcyjnym lub odblokowania go za pomocą pakietu kredytów API. Wskazuje, czy wybór konkretnej domeny jest odblokowany w Twoim planie.
Pobierz domeny aliasów Outlook
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "domains": [
            {
                "domain": "outlook.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            },
            {
                "domain": "hotmail.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            }
        ]
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.domains array
Aktywne domeny Outlook/Hotmail; pusty array jest prawidłowy.
data.domains[].domain string
Dostępna nazwa domeny.
data.domains[].type string
Czytelna etykieta dostawcy.
data.domains[].selectable boolean
Czy Twoje konto może wyraźnie wybrać tę domenę.
data.domains[].locked boolean
Czy wyraźny wybór domeny jest zablokowany dla Twojego konta.
data.domains[].disabled_reason string|null
Powód, dla którego wybór domeny jest zablokowany, lub null, gdy jest możliwy do wyboru.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Utwórz alias Outlook

Utwórz nową tymczasową skrzynkę pocztową aliasu Outlook / Hotmail należącą do uwierzytelnionego użytkownika.

Parametry 7
Parametr Lokalizacja Typ Status Opis
domain body string opcjonalny
Użyj losowego lub domeny z GET /outlook-alias/domains; outlook_alias_domain jest również akceptowane. Bez uprawnienia wyboru używany jest losowy.
Domyślnie: Losowa dostępna domena
username body string opcjonalny
Opcjonalny niestandardowy przyrostek aliasu: od 2 do 32 znaków ASCII (litery lub cyfry), znormalizowany do małych liter; podlega uprawnieniom funkcji. Akceptuje także custom_username lub alias_username.
Domyślnie: Automatycznie wygenerowane
lifetime body string opcjonalny
dozwolone wartości:
10m — 10 minut 1h — 1 Godzina 2h — 2 godziny 1d — 1 dzień 1w — 1 Tydzień 1m — 30 dni 3m — 90 dni 6m — 180 dni 1y — 365 dni unlimited — Nielimitowane
Domyślnie: Domyślny okres życia planu
pin_enabled body boolean opcjonalny
Opcjonalna ochrona PIN dla nowej skrzynki pocztowej, jeśli jest dozwolona w Twoim planie. Nie zmienia ona PIN-u istniejącej skrzynki pocztowej.
Domyślnie: false
pin body string opcjonalny
Wymagane, gdy pin_enabled jest prawdziwe: PIN składający się z 6 do 8 cyfr, przesyłany jako ciąg znaków, aby zachować wiodące zera.
pin_confirmation body string opcjonalny
Wymagane, gdy pin_enabled jest true. Musi dokładnie pasować do pinu.
Idempotency-Key header string opcjonalny
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
Wymaga włączenia uprawnienia Outlook Alias API w Twoim planie subskrypcyjnym lub odblokowania go za pomocą pakietu kredytów API. Opcjonalne parametry: domain (np. outlook.com, hotmail.com), username (niestandardowa nazwa aliasu użytkownika), lifetime (dozwolone wartości: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Pomiń czas życia lub pozostaw pole puste, aby użyć domyślnego czasu życia e‑mail skonfigurowanego dla Twojego bieżącego planu miesięcznego/rocznego. Wyślij dozwolony czas życia, na przykład 1h, aby nadpisać tę domyślną wartość. Nieograniczony jest używany tylko wtedy, gdy jest skonfigurowany jako domyślny w planie lub wyraźnie żądany i dozwolony. Parametry w treści mailbox_lifetime i email_lifetime są również akceptowane; pierwsza niepusta wartość wygrywa w następującej kolejności: lifetime, mailbox_lifetime, email_lifetime. Nieprawidłowe lub niedozwolone wartości zwracają HTTP 422 zamiast cichego wybierania wartości domyślnej.
Utwórz alias skrzynki pocztowej Outlook
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2306,
        "pin_protected": false,
        "email": "example+alias45@outlook.com",
        "domain": "outlook.com",
        "provider": "outlook_alias",
        "expire_at": "2026-11-19T03:17:52+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:52+00:00",
        "email_token": "encrypted-email-token"
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.id integer
Identyfikator skrzynki pocztowej. Wygenerowane identyfikatory, adresy i tokeny różnią się dla każdej skrzynki.
data.pin_protected boolean
Czy ta skrzynka pocztowa ma ochronę PIN. Żaden PIN ani hash PIN nie jest zwracany.
data.email string
Wygenerowano pełny adres skrzynki pocztowej.
data.domain string
Domena generowanej skrzynki pocztowej.
data.provider string
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
data.expire_at string|null
Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej.
data.expires_in_seconds number|null
Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero.
data.mailbox_state string
Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny.
data.receiving_enabled boolean
Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości?
data.message_count integer
Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.unread_message_count integer
Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
data.last_message_received_at string|null
Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny.
data.message_count_synced_at string|null
Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją.
data.created_at string|null
Czas utworzenia skrzynki pocztowej w formacie ISO-8601.
data.email_token string
Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej. Nie zastępuje uwierzytelniania Bearer, kontroli własności ani autoryzacji PIN.
data.pin_grant object
Warunkowo: aktywne tworzenie skrzynki chronionej PIN-em zwraca to uprawnienie do odczytu; zwykłe niechronione tworzenie pomija je.
data.pin_grant.mailbox_id integer
Identyfikator skrzynki pocztowej, do którego jest przypisane warunkowe zezwolenie na odczyt.
data.pin_grant.unlock_token string
Nieprzezroczysty token odczytu dla X-Mailbox-Unlock z tymi samymi poświadczeniami właściciela. Przechowuj go prywatnie w pamięci; przyznanie odczytu nie upoważnia do usunięcia.
data.pin_grant.scope string
Zakres odczytu dla warunkowego przyznania tworzenia.
data.pin_grant.idle_timeout_seconds integer
Dozwolony czas bezczynności dla przyznania odczytu, zazwyczaj 3600 sekund.
data.pin_grant.absolute_timeout_seconds integer
Maksymalny czas życia przyznania odczytu, zazwyczaj 86400 sekund.
data.pin_grant.expires_at string
Obecny termin wygaśnięcia przyznania odczytu w formacie ISO-8601.
data.pin_grant.absolute_expires_at string
Bezwzględny termin wygaśnięcia przyznania uprawnienia do odczytu w formacie ISO-8601. Zmiany w zabezpieczeniach mogą odwołać przyznanie wcześniej.

Wiadomości i załączniki

Pobierz przychodzące skrzynki odbiorcze, odczytaj pełne wiadomości HTML/tekstowe i strumieniuj załączniki.

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

Wyświetl wiadomości skrzynki pocztowej

Pobierz dostępne podsumowania wiadomości i metadane skrzynki pocztowej. Standardowe skany skrzynki odbiorczej zwracają ostatnią partię do 25 wiadomości; nie jest to strona z pełną historią. Użyj GET /messages/{messageId} aby uzyskać pełne treści i załączniki.

Parametry 2
Parametr Lokalizacja Typ Status Opis
email query string wymagane
Pełny adres e‑mail posiadanej skrzynki pocztowej, z której odczytywać wiadomości. Zakoduj wartość zapytania w formacie URL; zakoduj znak plus jako %2B.
X-Mailbox-Unlock header string opcjonalny
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie Bearer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
E‑mail musi należeć do Twojego konta. Standardowe i podsumowania Gmail zawierają pola OTP i verification-link; Outlook dodatkowo zawiera pola from_name, snippet, received_at i has_attachments. Synchronizacja dostawcy oraz buforowanie mogą opóźniać nowe wiadomości i ich liczbę.
Przeczytaj wiadomości w skrzynce pocztowej
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "mailbox": "demo123@example.com",
    "email_token": "encrypted-email-token",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "receivedAt": "2026-11-19 02:17:52",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "otp": null,
            "otp_locked": false,
            "verification_link": null,
            "verification_link_locked": false
        }
    ],
    "mailbox_provider": "standard",
    "mailbox_state": "active",
    "expire_at": "2026-11-20T02:17:52+00:00",
    "expires_in_seconds": 86399.75,
    "receiving_enabled": true,
    "mailbox_limit": {
        "limit": 50,
        "limit_label": "50",
        "active_count": 1,
        "paused_count": 0,
        "paused_mailboxes": [],
        "remaining": 49,
        "remaining_label": "49",
        "reached": false,
        "blocked": false,
        "provider": "standard"
    },
    "message_count": 1,
    "unread_message_count": 1,
    "last_message_received_at": "2026-11-19T02:17:52+00:00",
    "message_count_synced_at": "2026-11-19T02:17:52+00:00"
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
mailbox string
Adres skrzynki pocztowej, z której żądano wiadomości.
email_token string
Nieprzezroczyste zaszyfrowane odniesienie do skrzynki pocztowej; nadal wymagana jest standardowa autoryzacja.
mailbox_provider string
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
messages array
Podsumowania wiadomości. Pusta skrzynka odbiorcza zwraca pustą tablicę; pobierz pojedynczą wiadomość, aby uzyskać jej treść i załączniki.
expire_at string|null
Skuteczny termin wygaśnięcia jako znacznik czasu ISO-8601 lub null dla nieograniczonej skrzynki pocztowej.
expires_in_seconds number|null
Nieujemna liczba sekund pozostałych po obliczeniu; możliwe są ułamkowe sekundy. Null oznacza nieograniczone, a nie zero.
mailbox_state string
Aktualny stan skrzynki pocztowej: aktywny, wstrzymany, wygasły lub nieaktywny.
receiving_enabled boolean
Czy ta skrzynka pocztowa obecnie przyjmuje przychodzące wiadomości?
message_count integer
Znana całkowita liczba wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
unread_message_count integer
Znana liczba nieprzeczytanych wiadomości; może odzwierciedlać ostatnią synchronizację skrzynki pocztowej.
last_message_received_at string|null
Ostatnio znany czas otrzymanej wiadomości w formacie ISO-8601, lub null, gdy niedostępny.
message_count_synced_at string|null
Ostatni czas synchronizacji liczby wiadomości w formacie ISO-8601 lub null przed synchronizacją.
mailbox_limit.limit integer
Aktywny limit skrzynek pocztowych dla tego dostawcy; -1 oznacza nieograniczony.
mailbox_limit.limit_label string
Etykieta wyświetlana dla limitu skrzynki pocztowej.
mailbox_limit.active_count integer
Liczba aktywnych skrzynek pocztowych dla tego dostawcy.
mailbox_limit.paused_count integer
Liczba wstrzymanych skrzynek pocztowych dla tego dostawcy.
mailbox_limit.paused_mailboxes array<string>
Adresy wstrzymane z powodu limitu skrzynki pocztowej.
mailbox_limit.remaining integer
Pozostałe aktywne sloty skrzynek pocztowych; -1 oznacza nieograniczone. To nie jest limit zapytań API.
mailbox_limit.remaining_label string
Wyświetl etykietę dla pozostałych miejsc w skrzynce pocztowej.
mailbox_limit.reached boolean
Czy osiągnięto limit aktywnych skrzynek pocztowych.
mailbox_limit.blocked boolean
Czy limit aktywnej skrzynki pocztowej wynosi zero.
mailbox_limit.provider string|null
Dostawca, którego dotyczy limit skrzynki pocztowej.
messages[].id string
Nieprzezroczysty identyfikator wiadomości używany przez endpointy pojedynczej wiadomości, usuwania i załącznika.
messages[].is_seen boolean
Czy wiadomość jest oznaczona jako przeczytana.
messages[].subject string
Temat wiadomości.
messages[].from string
Wyświetlana nazwa nadawcy lub adres.
messages[].from_email string
Adres e‑mail nadawcy.
messages[].receivedAt string
Czas otrzymania w strefie czasowej aplikacji, sformatowany jako YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Wykryto jednorazowy kod, gdy jest dostępny i dozwolony; w przeciwnym razie null.
messages[].otp_locked boolean
Czy wykryty jednorazowy kod jest ukryty przez uprawnienia funkcji.
messages[].verification_link string|null
Wykryto adres URL weryfikacji, gdy jest dostępny i dozwolony; w przeciwnym razie null.
messages[].verification_link_locked boolean
Czy wykryty link weryfikacyjny jest ukryty przez uprawnienia funkcji.
messages[].from_name string|null
Pole podsumowania Outlook: nazwa oryginalnego nadawcy. Brak w podsumowaniach Standard i Gmail.
messages[].snippet string|null
Pole podsumowania Outlook: krótki podgląd wiadomości.
messages[].received_at string|null
Pole podsumowania Outlook: otrzymany czas w formacie ISO-8601, gdy jest znany.
messages[].has_attachments boolean
Pole podsumowania Outlook: czy istnieją metadane załącznika. Dostępność pobierania jest sprawdzana osobno.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Pobierz pojedynczą wiadomość

Pobierz własną wiadomość za pomocą jej nieprzezroczystego identyfikatora wiadomości. Zwraca formaty treści i metadane załączników. Pola treści zależą od formatu wiadomości; Outlook dodaje poniżej wymienione pola specyficzne dla dostawcy.

Parametry 2
Parametr Lokalizacja Typ Status Opis
messageId path string wymagane
Unikalny identyfikator wiadomości zwracany w liście wiadomości.
X-Mailbox-Unlock header string opcjonalny
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie Bearer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Przeczytaj jedną wiadomość
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "demo123@example.com",
        "mailbox_provider": "standard",
        "receivedAt": "2026-11-19 02:17:52",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "html_content": "<p>Hello from the inbox.</p>",
        "text_content": "<pre>Hello from the inbox.</pre>",
        "content": "<p>Hello from the inbox.</p>",
        "attachments": [
            {
                "name": "file.txt",
                "extension": "txt",
                "size": 91,
                "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
            }
        ]
    }
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
data.id string
Nieprzezroczysty identyfikator wiadomości.
data.is_seen boolean
Stan odczytu wiadomości. Odczyt może oznaczyć ją jako przeczytaną; dane w pamięci podręcznej mogą odzwierciedlać wcześniejszy stan.
data.subject string
Temat wiadomości.
data.from string
Wyświetlana nazwa nadawcy lub adres.
data.from_email string
Adres e‑mail nadawcy.
data.to string
Adres skrzynki odbiorczej odbiorcy.
data.mailbox_provider string
Dostawca skrzynki pocztowej: standard, gmail_alias lub outlook_alias.
data.receivedAt string
Czas otrzymania w strefie czasowej aplikacji, sformatowany jako YYYY-MM-DD HH:mm:ss.
data.html boolean
Czy wiadomość ma ciało w formacie HTML.
data.html_content string
Treść HTML, gdy jest obecna. Standardowe wiadomości bez HTML mogą pominąć to pole. Traktuj zawartość wiadomości jako nieufną.
data.text_content string
Treść tekstu, gdy jest obecna; Standardowe wiadomości mogą zawierać tekst z escapowanymi znakami w elemencie pre lub pominąć to pole.
data.content string
Preferowana treść do wyświetlenia, zazwyczaj HTML, gdy dostępna.
data.attachments array
Metadane załącznika lub pustą tablicę. Pobieranie wymaga normalnego uwierzytelnienia i odpowiedniej autoryzacji kodem PIN.
data.attachments[].name string
Nazwa pliku do zakodowania w URL jako pojedynczy segment ścieżki podczas pobierania.
data.attachments[].size integer
Rozmiar załącznika w bajtach.
data.attachments[].url string
Adres URL pobierania API uwierzytelnionego użytkownika został dodany do załączników z nazwą pliku. URL nie gwarantuje, że lokalny plik jest dostępny.
data.attachments[].extension string
Standardowe/pole metadanych Gmail: rozszerzenie pliku, jeśli podano.
data.attachments[].id string
Pole metadanych Outlook: identyfikator załącznika dostawcy.
data.attachments[].content_type string
Pole metadanych Outlook: typ zawartości MIME.
data.from_name string|null
Pole szczegółowe Outlook: oryginalna nazwa nadawcy.
data.to_email string|null
Pole szczegółowe Outlook: oryginalny adres odbiorcy.
data.received_at string|null
Pole szczegółowe Outlook: otrzymany czas w formacie ISO-8601.
data.has_html boolean
Pole szczegółowe Outlook: czy istnieje treść HTML.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Usuń wiadomość

Usuń jedną wiadomość należącą do użytkownika.

Parametry 3
Parametr Lokalizacja Typ Status Opis
messageId path string wymagane
Unikalny ciąg identyfikatora wiadomości do trwałego usunięcia.
X-Mailbox-Unlock header string opcjonalny
Nagłówek, tylko chronione skrzynki pocztowe: użyj jednorazowego tokenu unlock_token do usuwania. Najpierw wyślij POST pin, scope=delete i action/target_id zwrócone w odpowiedzi 423 na URL odblokowujący PIN. Token odczytu nie może usuwać. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string opcjonalny
Wymagane przy tworzeniu lub usuwaniu chronionym PIN-em: stabilny klucz o długości od 16 do 128 znaków. Powtórz identyczne żądanie z tym samym kluczem, aby uniknąć podwójnej pracy.
Usuń jedną wiadomość
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Pola odpowiedzi
Pole Typ Opis
status boolean
Czy operacja zakończyła się sukcesem?
message string
Wynik usunięcia. Brakujący zasób zwraca HTTP 404.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Pobierz załącznik

Pobierz załącznik z wiadomości należącej do użytkownika.

Parametry 3
Parametr Lokalizacja Typ Status Opis
messageId path string wymagane
Identyfikator wiadomości zawierającej plik.
filename path string wymagane
Nazwa pliku i rozszerzenie załącznika do pobrania.
X-Mailbox-Unlock header string opcjonalny
Nagłówek, tylko chronione skrzynki pocztowe: użyj tokenu odblokowania do odczytu. Najpierw wyślij POST pin i scope=read do URL odblokowania PIN. Zachowaj normalne uwierzytelnianie Bearer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Sukces zwraca bajty pliku, a nie JSON. Zbyt duże pliki zwracają HTTP 403; brakujące lub niedostępne pliki lokalne zwracają HTTP 404. Zakoduj nazwę pliku w URL jako pojedynczy segment ścieżki. Same metadane załącznika nie gwarantują dostępności pobrania.
Pobierz załącznik
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
Zachowanie podczas pobierania Ten punkt końcowy zwraca żądany plik bezpośrednio zamiast ciała JSON.
Pola odpowiedzi
Pole Typ Opis
Content-Disposition header
Udana odpowiedź pobiera żądaną nazwę pliku.
body binary
Bajty pliku przy sukcesie, nie JSON. Błędy zwracają JSON z kodem statusu innym niż 2xx.

Limity i kwoty

Monitoruj w czasie rzeczywistym budżety żądań, limity szybkości i limity kont bez zużywania kredytów.

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

Limit szybkości i limit przydziału

Sprawdź aktualny limit szybkości i status przydziału, nie zużywając żadnego użycia API. Ten punkt końcowy jest wolny od przydziału i nie odejmuje miesięcznych kredytów API (limit ochrony przed nadużyciami: 60 żądań/min).

X-RateLimit-* opisuje wskazany budżet żądań; X-Quota-* opisuje miesięczną i zakupioną pojemność, gdy jest dostępna. X-Mailbox-RateLimit-* raportuje oddzielny budżet tworzenia/aktualizacji skrzynki pocztowej. Odrzucenie dotyczące wyłącznie skrzynki pocztowej używa zakresu skrzynki i własnego okna ponownej próby. Odrzucenia limitu minutowego mogą pomijać informacje o kwocie. Retry-After jest dołączany tylko przy czasowej ponownej próbie; wyłączony dostęp może wymagać zmiany konta. W tej udanej odpowiedzi statusowej, data.limit, data.remaining i data.reset opisują budżet minutowy konta, a nie wydajne kredyty. Obiekt data.quota opisuje miesięczny przydział, salda kredytów i ich użycie. Istniejące pola data.monthly_limit, data.monthly_remaining i data.purchased_credits pozostają aliasami odpowiadających im pól quota. Pomyślne sprawdzenie statusu nie upoważnia do kolejnej operacji API. Operacje nadal wymagają włączonego dostępu, dostępnego przydziału i akceptacji we wszystkich obowiązujących limitach. Migawka przydziału nie gwarantuje pojemności już zarezerwowanej przez trwające żądanie.
Sprawdź status limitu zapytań
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ilustrująca odpowiedź przy użyciu danych syntetycznych. Identyfikatory, adresy, tokeny, znaczniki czasu, limity planu i liczby się różnią. Przykładowe okresy ważności nie nadpisują domyślnych ustawień Twojego planu. Opisy pól odpowiedzi wskazują pola dopuszczające wartość null oraz specyficzne dla dostawcy.

Przykładowa odpowiedź
200 OK • JSON
{
    "status": "success",
    "data": {
        "limit": 60,
        "remaining": 45,
        "reset": 32,
        "plan": "premium",
        "monthly_limit": 50000,
        "monthly_remaining": 48210,
        "purchased_credits": 5000,
        "quota": {
            "enabled": true,
            "user_api_status": true,
            "plan_name": "Premium Plan",
            "period": "2026-10",
            "base_limit": 50000,
            "extra_requests": 0,
            "monthly_limit": 50000,
            "monthly_remaining": 48210,
            "used": 1790,
            "purchased_credits": 5000,
            "bonus_credits": 1000,
            "direct_purchased_credits": 4000,
            "remaining": 53210,
            "unlimited": false,
            "usage_percent": 3,
            "reset_at": "2026-11-01T00:00:00+00:00"
        }
    }
}
Pola odpowiedzi
Pole Typ Opis
data.limit integer|string
Limit żądań na minutę konta. Ciąg unlimited oznacza nieograniczony budżet minutowy; jest to niezależne od miesięcznego limitu.
data.remaining integer|string
Pozostałe sloty minutowego budżetu konta, lub ciąg "unlimited". Dodatnia wartość nie oznacza, że pozostały kredyty API.
data.reset integer
Sekundy dla okna minutowego konta, a nie resetu miesięcznego przydziału. Wyłączone lub nieograniczone budżety minutowe mogą zachować nominalną wartość 60 sekund; nie gwarantuje to dostępu po oczekiwaniu.
data.plan string
Aktualny znacznik planu. Czytelna nazwa planu jest podana osobno w data.quota.plan_name.
data.quota.enabled boolean
Czy dostęp globalny oraz planowy/kredytowy do API jest włączony. To nie wskazuje pozostałej pojemności ani nie zastępuje przełącznika API użytkownika.
data.quota.user_api_status boolean
Czy użytkownik włączył przełącznik API użytkownika. Operacje wymagają tego przełącznika, a także włączonego dostępu i dostępnej pojemności.
data.quota.plan_name string
Czytelna nazwa bieżącego planu.
data.quota.period string
Okres użytkowania w formacie miesiąca kalendarzowego YYYY-MM, z użyciem strefy czasowej aplikacji; niekoniecznie okres rozliczeniowy subskrypcji.
data.quota.base_limit integer
Podstawowy miesięczny przydział planu. Wartość -1 oznacza nieograniczoną.
data.quota.extra_requests integer
Dodatkowy miesięczny przydział przyznany na bieżący okres użytkowania; oddzielny od zakupionych kredytów.
data.quota.monthly_limit integer
Podstawowy przydział plus dodatkowe żądania z bieżącego okresu. Wartość -1 oznacza nieograniczony. Zakupione kredyty nie są uwzględnione.
data.quota.monthly_remaining integer|null
Pozostały skończony miesięczny przydział, lub null, gdy miesięczny przydział jest nieograniczony. Null nie powinien być interpretowany jako zero.
data.quota.used integer
Udane, liczone operacje API w bieżącym okresie użytkowania, w tym operacje wykorzystujące kredyty. Kontrole statusu nie zwiększają tej wartości.
data.quota.purchased_credits integer
Aktualny stan kredytów, w tym bonusowe kredyty z aktywnego planu. Bonusowe kredyty nie powinny być dodawane do tego stanu po raz drugi.
data.quota.bonus_credits integer
Aktywna część bonusu planu w saldzie kredytów; rozbicie purchased_credits, a nie dodatkowa pojemność.
data.quota.direct_purchased_credits integer
Saldo kredytów z wyłączeniem aktywnej części bonusu planu. Ta wartość plus bonus_credits równa się purchased_credits.
data.quota.remaining integer|null
Miesięczny pozostały limit plus bieżące saldo kredytowe, bez podwójnego liczenia bonusów. Null oznacza nieograniczony miesięczny limit. Indywidualne uprawnienia funkcji i inne limity żądań nadal obowiązują.
data.quota.unlimited boolean
Czy miesięczny limit jest nieograniczony. Nie powoduje to, że budżet minutowy konta lub inne limity funkcji są nieograniczone.
data.quota.usage_percent integer
Kompatybilny z panelem kontrolnym, zaokrąglony procent od 0 do 100: użyte podzielone przez użyte plus pozostałe, pomnożone przez 100. Zawiera dostępny przydział kredytowy, więc doładowanie może obniżyć procent. Wynosi 0 dla nieograniczonego limitu lub puli o zerowym rozmiarze; nie jest to procent limitu na minutę ani decyzja o dostępie.
data.quota.reset_at string
Znacznik czasu ISO-8601 z przesunięciem strefy czasowej dla następnego resetu limitu w kolejnym miesiącu kalendarzowym. To nie jest data wygaśnięcia subskrypcji, a miesięczny reset nie uzupełnia zakupionych kredytów.
status string
Dosłowny sukces dla tego punktu końcowego statusu. Inne udane punkty końcowe skrzynek używają wartości logicznej true.
data.monthly_limit integer
Alias zgodności odpowiadającego pola data.quota; nie dodawaj go ponownie przy obliczaniu sald.
data.monthly_remaining integer|null
Alias zgodności odpowiadającego pola data.quota; nie dodawaj go ponownie przy obliczaniu sald.
data.purchased_credits integer
Alias zgodności odpowiadającego pola data.quota; nie dodawaj go ponownie przy obliczaniu sald.

Ochrona PIN skrzynki pocztowej

Wprowadź kod PIN, aby kontynuować. Twoja skrzynka pocztowa pozostaje odblokowana, dopóki jest aktualna w tej sesji witryny.

Czy akceptujesz pliki cookie?

Używamy plików cookie, aby poprawić Twoje doświadczenia podczas przeglądania. Korzystając z tej strony, wyrażasz zgodę na naszą politykę plików cookie.

Więcej