Documentação da API
Referência da TempMail API v1
URL base
https://mail.taohuaxin.topAutenticação
Todos os endpoints, exceto /config, exigem autenticação.
Adicione o seguinte cabeçalho a todas as requisições:
x-api-key: tm_your_token_hereObtenha seu token em: Painel → Configurações → Chaves de API
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /api/v1/config | Configuração do servidor (pública — sem autenticação necessária) |
| GET | /api/v1/me | Buscar e-mails de todas as suas caixas (long-poll) |
| GET | /api/v1/inbox/:address | Buscar e-mails de uma única caixa (long-poll) |
| DELETE | /api/v1/inbox/:address | Limpar todos os e-mails de uma caixa |
| GET | /api/v1/email/:id | Obter e-mail completo analisado (texto + html + anexos) |
| GET | /api/v1/email/:id/rendered | Obter o texto renderizado do e-mail |
| GET | /api/v1/email/:id/attachments/:attachmentId | Baixar um anexo por ID |
| DELETE | /api/v1/email/:id | Excluir um único e-mail |
| GET | /api/v1/domains | Listar seus domínios personalizados |
| POST | /api/v1/domains | Adicionar um domínio personalizado |
| DELETE | /api/v1/domains/:id | Remover um domínio personalizado |
docs.examples
/api/v1/configConfiguração do servidor (pública — sem autenticação necessária)
curl https://mail.taohuaxin.top/api/v1/configdocs.response
{
"domains": ["taohuaxin.top"],
"smtpPort": 25,
"smtpsPort": 465,
"mxPort": 25,
"version": "1.0.0"
}/api/v1/meBuscar e-mails de todas as suas caixas (long-poll)
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"
}/api/v1/inbox/:addressBuscar e-mails de uma única caixa (long-poll)
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"
}/api/v1/inbox/:addressLimpar todos os e-mails de uma caixa
curl -X DELETE -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/inbox/[email protected]"docs.response
{ "success": true }/api/v1/email/:idObter e-mail completo analisado (texto + html + anexos)
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 }
]
}/api/v1/email/:id/renderedObter o texto renderizado do e-mail
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>/api/v1/email/:id/attachments/:attachmentIdBaixar um anexo por 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>/api/v1/email/:idExcluir um único 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 }/api/v1/domainsListar seus domínios personalizados
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"
}
]/api/v1/domainsAdicionar um domínio personalizado
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"
}/api/v1/domains/:idRemover um domínio personalizado
curl -X DELETE -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/domains/dom_02"docs.response
{ "success": true }Long Poll
Os endpoints de caixa suportam long-polling. Chame uma vez e o servidor aguarda até a chegada de e-mails (máx. 25 s). Retorna 204 se nenhum e-mail chegar antes do timeout.
Parâmetros de consulta
| Parâmetro | Descrição |
|---|---|
| since | Cursor da resposta anterior; apenas e-mails posteriores a este são retornados |
| count | Retornar quando N novos e-mails tiverem chegado (padrão 1, máx. 50) |
| limit | Máximo de e-mails por resposta (padrão 20, máx. 50) |
| from | Filtrar — retornar apenas e-mails cujo De contenha esta substring |
| subject | Filtrar — retornar apenas e-mails cujo Assunto contenha esta substring |
Comportamento de exclusão
Todas as operações DELETE são exclusões suaves: os itens excluídos ficam ocultos para os usuários, mas permanecem acessíveis aos administradores para fins de auditoria.