Receber e-mails: Leitura
Obter mensagens
Leia até 50 mensagens por id, com o corpo, a lista de anexos e os headers.
https://g.sendcorex.com/v1command: get_messagesO corpo HTML é retornado bruto, sem sanitização. Sanitize-o no seu cliente antes de renderizar.
Argumentos
idsstring[]opcionalAté 50 ids de mensagem.
idstringopcionalUm único id de mensagem. Use este ou
ids.includestring[]opcionalO que adicionar a cada mensagem:
body,attachments,headers,full_headers. O padrão é["body","attachments"].ex.:
["body", "headers", "attachments"]
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "get_messages",
args: {
ids: [
"Vj0xQUJDMTIz"
],
include: [
"body",
"headers",
"attachments"
]
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Resposta
{
"type": "SUCCESS",
"results": [
{
"command": "get_messages",
"id": "0",
"type": "SUCCESS",
"data": {
"messages": [
{
"message_uid": "Vj0xQUJDMTIz",
"thread_id": "thr_9a1c4e72",
"message_id": "<3f2a1b4c@SCOREX123MB45.prd.sendcorex.com>",
"folders": [
"INBOX"
],
"labels": [
"cliente-vip"
],
"from_name": "Ana Costa",
"from_email": "ana@client.com",
"to": [
{
"email": "you@yourdomain.com"
}
],
"cc": [],
"bcc": [],
"subject": "Invoice for September",
"is_read": false,
"is_starred": false,
"is_important": false,
"snoozed_until": null,
"received_at": "2026-10-09T14:21:07Z",
"body": {
"html": "<p>Hi, attached is the invoice.</p>",
"text": "Hi, attached is the invoice.",
"external_images": false
},
"headers": {
"content_type": "multipart/mixed",
"ip_address": "203.0.113.10",
"is_tls": true,
"spf_success": true,
"dkim_success": true,
"dmarc_success": true,
"spam_score": 0.4,
"list_unsubscribe": null
},
"attachments": [
{
"attachment_id": "Vj0xQVRUMDE",
"file_name": "invoice.pdf",
"mime_type": "application/pdf",
"size_bytes": 48213,
"inline": false,
"content_id": null
}
]
}
],
"not_found": []
}
}
]
}Campos da resposta
messages[]Os campos de envelope e de estado (
folders,labels,to,cc,bcc,references,snoozed_until…) mais o que você pediu eminclude.messages[].body{ html, text, external_images }. O HTML é bruto e não sanitizado.messages[].headerscontent_type,ip_address,is_tls,spf_success,dkim_success,dmarc_success,spam_score,list_unsubscribe,list_id,sender_provider(de onde o e-mail foi enviado, verificado na entrega),rules_matched…messages[].agent_score / agent_reasonsSó em
AgentseNotSubscribing: a pontuação da triagem e o que a disparou.messages[].full_headersTudo de
headersmaisheaders_json,received_chain,spf_result,dkim_result,dmarc_resultespam_result.messages[].attachmentsUma lista com
attachment_id,file_name,mime_type,size_bytes,inline,content_ide os camposscan_*. O arquivo em si não vem incluído.not_foundIds que não existem nesta caixa de correio.
Baixar um anexo
A lista de anexos nunca traz o binário. Pegue o attachment_id e baixe o arquivo com a rota Raw Message.
GET /v1/raw?message_id=<message_uid>&attachment_id=<attachment_id>. O tipo MIME original volta em X-Original-Content-Type.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
TOKEN_EXPIREDO access token expirou. Chame Refresh Token e repita a requisição.
- 401
INVALID_TOKENO token está malformado, é desconhecido ou foi revogado.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.
- CMD
INVALID_ARGSUm argumento obrigatório está ausente ou é inválido.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.