TempMail

Dokumentacja API

TempMail API v1 — Dokumentacja

Bazowy URL

https://mail.taohuaxin.top

Uwierzytelnianie

Wszystkie endpointy oprócz /config wymagają uwierzytelnienia.

Dodaj następujący nagłówek do wszystkich żądań:

x-api-key: tm_your_token_here

Uzyskaj token w: Panel → Ustawienia → Klucze API

Endpointy

MetodaŚcieżkaOpis
GET/api/v1/configKonfiguracja serwera (publiczna — uwierzytelnienie nie jest wymagane)
GET/api/v1/mePobierz e-maile ze wszystkich skrzynek (długie odpytywanie)
GET/api/v1/inbox/:addressPobierz e-maile z jednej skrzynki (długie odpytywanie)
DELETE/api/v1/inbox/:addressWyczyść wszystkie e-maile w skrzynce
GET/api/v1/email/:idPobierz w pełni przeanalizowaną wiadomość (tekst + HTML + załączniki)
GET/api/v1/email/:id/renderedPobierz wyrenderowany tekst e-maila
GET/api/v1/email/:id/attachments/:attachmentIdPobierz jeden załącznik według ID
DELETE/api/v1/email/:idUsuń pojedynczy e-mail
GET/api/v1/domainsWyświetl własne domeny
POST/api/v1/domainsDodaj własną domenę
DELETE/api/v1/domains/:idUsuń własną domenę

docs.examples

GET/api/v1/config

Konfiguracja serwera (publiczna — uwierzytelnienie nie jest wymagane)

curl https://mail.taohuaxin.top/api/v1/config

docs.response

{
  "domains": ["taohuaxin.top"],
  "smtpPort": 25,
  "smtpsPort": 465,
  "mxPort": 25,
  "version": "1.0.0"
}
GET/api/v1/me

Pobierz e-maile ze wszystkich skrzynek (długie odpytywanie)

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/me?count=1&limit=20"

docs.response

{
  "emails": [
    {
      "id": "cmcg2a1b40001xyz",
      "fromAddress": "[email protected]",
      "subject": "Your verification code",
      "isRead": false,
      "receivedAt": "2026-07-10T08:30:00.000Z",
      "mailbox": { "address": "alice", "domain": "taohuaxin.top" }
    }
  ],
  "nextSince": "cmcg2a1b40001xyz"
}
GET/api/v1/inbox/:address

Pobierz e-maile z jednej skrzynki (długie odpytywanie)

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/inbox/[email protected]?since=cmcg2a1b40001xyz&count=1"

docs.response

{
  "emails": [
    {
      "id": "cmcg9f2c80002abc",
      "fromAddress": "[email protected]",
      "subject": "Welcome!",
      "isRead": false,
      "receivedAt": "2026-07-10T09:00:00.000Z"
    }
  ],
  "nextSince": "cmcg9f2c80002abc"
}
DELETE/api/v1/inbox/:address

Wyczyść wszystkie e-maile w skrzynce

curl -X DELETE -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/inbox/[email protected]"

docs.response

{ "success": true }
GET/api/v1/email/:id

Pobierz w pełni przeanalizowaną wiadomość (tekst + HTML + załączniki)

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz"

docs.response

{
  "id": "cmcg2a1b40001xyz",
  "fromAddress": "[email protected]",
  "toAddress": "[email protected]",
  "subject": "Your verification code",
  "bodyHtml": "<p>Your code is <b>123456</b></p>",
  "bodyText": "Your code is 123456",
  "isRead": true,
  "receivedAt": "2026-07-10T08:30:00.000Z",
  "attachments": [
    { "id": "att_01", "filename": "invoice.pdf", "mimeType": "application/pdf", "size": 24580 }
  ]
}
GET/api/v1/email/:id/rendered

Pobierz wyrenderowany tekst e-maila

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz/rendered"

docs.response

From: [email protected]
To: [email protected]
Subject: Your verification code
Date: Fri, 10 Jul 2026 08:30:00 GMT

<p>Your code is <b>123456</b></p>
GET/api/v1/email/:id/attachments/:attachmentId

Pobierz jeden załącznik według ID

curl -OJ -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz/attachments/att_01"

docs.response

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="invoice.pdf"
Content-Length: 24580

<binary file stream>
DELETE/api/v1/email/:id

Usuń pojedynczy e-mail

curl -X DELETE -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz"

docs.response

{ "success": true }
GET/api/v1/domains

Wyświetl własne domeny

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/domains"

docs.response

[
  {
    "id": "dom_01",
    "domain": "mail.example.com",
    "verified": true,
    "receiveMode": "inherit",
    "createdAt": "2026-07-01T00:00:00.000Z"
  }
]
POST/api/v1/domains

Dodaj własną domenę

curl -X POST -H "x-api-key: tm_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{"domain":"mail.example.com","receiveMode":"inherit"}' \
  "https://mail.taohuaxin.top/api/v1/domains"

docs.response

{
  "id": "dom_02",
  "domain": "mail.example.com",
  "verified": false,
  "receiveMode": "inherit",
  "createdAt": "2026-07-10T10:00:00.000Z"
}
DELETE/api/v1/domains/:id

Usuń własną domenę

curl -X DELETE -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/domains/dom_02"

docs.response

{ "success": true }

Długie odpytywanie

Endpointy skrzynek obsługują długie odpytywanie. Wywołaj raz, a serwer czeka na nadejście wiadomości (do 25 s). Zwraca 204, jeśli żadna wiadomość nie nadejdzie przed upływem czasu.

Parametry zapytania

ParametrOpis
sinceKursor z poprzedniej odpowiedzi; zwracane są tylko wiadomości po tym punkcie
countZwróć, gdy nadejdzie N nowych wiadomości (domyślnie 1, maks. 50)
limitMaksymalna liczba wiadomości w odpowiedzi (domyślnie 20, maks. 50)
fromFiltruj — zwracaj tylko wiadomości, których pole Od zawiera ten podłańcuch
subjectFiltruj — zwracaj tylko wiadomości, których Temat zawiera ten podłańcuch

Zachowanie przy usuwaniu

Wszystkie operacje DELETE to miękkie usunięcia: usunięte elementy są ukryte przed użytkownikami, ale pozostają dostępne dla administratorów do celów audytu.