Receber e-mails: Leitura
Listar mensagens
Liste as mensagens uma a uma, sem agrupá-las em conversas. Você também pode listar todas as mensagens que têm um marcador.
https://g.sendcorex.com/v1command: list_messagesArgumentos
folderstringopcionalPasta a listar. O padrão é
INBOX.limitnumberopcionalTamanho da página, de 1 a 100. O padrão é 25.
cursorstringopcionalO
next_cursorda página anterior.is_readbooleanopcionalFiltra pelo estado de leitura. Este filtro varre a pasta.
is_starredbooleanopcionalFiltra por estrela. Este filtro varre a pasta.
is_importantbooleanopcionalFiltra por importância. Este filtro varre a pasta.
is_spambooleanopcionalFiltra por spam. Este filtro varre a pasta.
afterstringopcionalSó mensagens recebidas nessa data ou depois. RFC 3339,
YYYY-MM-DD(UTC) ou epoch em milissegundos.beforestringopcionalSó mensagens recebidas antes dessa data. Mesmos formatos de
after.labelstringopcionalLista as mensagens com este marcador em todas as pastas.
foldere os filtros booleanos são ignorados. Não diferencia maiúsculas de minúsculas.afterebeforecontinuam funcionando.ex.:
"cliente-vip"
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "list_messages",
args: {
folder: "INBOX",
is_read: false,
limit: 50
}
}
]
},
{ 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": "list_messages",
"id": "0",
"type": "SUCCESS",
"data": {
"messages": [
{
"message_uid": "Vj0xQUJDMTIz",
"thread_id": "thr_9a1c4e72",
"folder": "INBOX",
"subject": "Invoice for September",
"preview": "Hi, attached is the invoice for September…",
"from_name": "Ana Costa",
"from_email": "ana@client.com",
"has_attachments": false,
"size_bytes": 4821,
"is_read": false,
"is_starred": false,
"is_important": false,
"is_spam": false,
"snoozed_until": null,
"received_at": "2026-10-09T14:21:07Z"
}
],
"has_more": false,
"next_cursor": null
}
}
]
}Campos da resposta
messages[].message_uidO id da mensagem.
messages[].thread_idA conversa à qual a mensagem pertence.
messages[].folderA pasta desta entrada.
messages[].subject / previewAssunto e uma prévia curta.
messages[].from_name / from_emailO remetente.
messages[].has_attachments / size_bytesFlag de anexo e tamanho da mensagem.
messages[].is_read / is_starred / is_important / is_spamEstado da mensagem.
messages[].snoozed_untilQuando uma mensagem adiada vence, ou
null.messages[].received_atQuando a mensagem foi recebida.
has_more / next_cursorPaginação.
Listar por marcador
Com label, o comando lê o índice de marcadores, então só as mensagens marcadas são examinadas. Cada mensagem vem com o estado atual em todas as pastas, então você recebe folders e labels em vez de um único folder.
Dados da resposta com marcador
{
"messages": [
{
"message_uid": "Vj0xQUJDMTIz",
"thread_id": "thr_9a1c4e72",
"subject": "Invoice for September",
"preview": "Hi, attached is the invoice for September…",
"from_name": "Ana Costa",
"from_email": "ana@client.com",
"folders": [
"INBOX"
],
"labels": [
"cliente-vip"
],
"is_read": false,
"is_starred": false,
"is_important": false,
"received_at": "2026-10-09T14:21:07Z"
}
],
"has_more": false,
"next_cursor": null
}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
INVALID_CURSORO cursor está malformado ou pertence a outra conta ou pasta.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.