Receber e-mails: Leitura

Listar threads

Liste as conversas de uma pasta, no estilo do Gmail, com filtros de não lidas, com estrela, importantes, anexos e datas.

POSThttps://g.sendcorex.com/v1command: list_threads
i

Cada item é uma conversa. Abra-a com get_thread ou get_messages usando o last_message_uid dela.

Argumentos

  • folderstringopcional

    Pasta a listar. O padrão é INBOX.

  • limitnumberopcional

    Tamanho da página, de 1 a 100. O padrão é 25.

  • cursorstringopcional

    O next_cursor da página anterior.

  • is_readbooleanopcional

    false retorna só conversas com alguma mensagem não lida.

  • is_starredbooleanopcional

    Filtra por estrela.

  • is_importantbooleanopcional

    Filtra por importância.

  • has_attachmentsbooleanopcional

    Filtra por anexos.

  • afterstringopcional

    Só conversas cuja última mensagem é dessa data em diante (inclusive). RFC 3339, YYYY-MM-DD (UTC) ou epoch em milissegundos.

    ex.: "2026-10-01"

  • beforestringopcional

    Só conversas cuja última mensagem é anterior a essa data (exclusive). Mesmos formatos de after.

    ex.: "2026-10-08T00:00:00+08:00"

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "list_threads",
        args: {
          folder: "INBOX",
          is_read: false,
          limit: 20
        }
      }
    ]
  },
  { 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_threads",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "threads": [
          {
            "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",
            "participants": [
              "ana@client.com",
              "you@yourdomain.com"
            ],
            "last_senders": [
              "ana@client.com"
            ],
            "message_count": 2,
            "thread_message_count": 3,
            "unread_count": 1,
            "has_unread": true,
            "has_starred": false,
            "has_important": false,
            "has_attachments": false,
            "last_message_uid": "Vj0xQUJDMTIz",
            "last_message_at": "2026-10-09T14:21:07Z"
          }
        ],
        "has_more": true,
        "next_cursor": "eyJwIjoyfQ"
      }
    }
  ]
}

Campos da resposta

  • threads[].thread_id

    O id da conversa.

  • threads[].folder

    A pasta sendo listada.

  • threads[].subject

    Assunto da conversa.

  • threads[].preview

    Prévia curta da mensagem mais recente.

  • threads[].from_name / from_email

    Remetente da mensagem mais recente.

  • threads[].participants

    Todos os participantes da conversa.

  • threads[].last_senders

    Quem escreveu as mensagens mais recentes.

  • threads[].message_count

    Mensagens nesta pasta.

  • threads[].thread_message_count

    Mensagens na conversa inteira.

  • threads[].unread_count / has_unread

    Mensagens não lidas na conversa.

  • threads[].has_starred / has_important / has_attachments

    Flags da conversa.

  • threads[].last_message_uid

    O id para abrir a conversa com get_messages ou get_thread.

  • threads[].last_message_at

    Data da mensagem mais recente.

  • has_more / next_cursor

    Paginação. Envie next_cursor como cursor para obter a próxima página.

Filtros e velocidade

is_read: false, is_starred: true e is_important: true usam um índice próprio, então só as conversas que batem são examinadas, não a pasta inteira. Se você combiná-los, um índice é usado (estrela, depois importante, depois não lida) e o resto é filtrado em cima dele. after e before são intervalos de chave, então nada fora do período é varrido. has_attachments e os valores false de estrela e importante ainda varrem a pasta.

Conversas não lidas em um intervalo de datas

{
  "commands": [
    {
      "command": "list_threads",
      "args": {
        "is_read": false,
        "after": "2026-10-01",
        "before": "2026-10-08T00:00:00+08:00"
      }
    }
  ]
}

Paginação

Quando has_more for true, chame o comando de novo com cursor igual a next_cursor.

Node.js

let cursor;
const threads = [];

do {
  const [result] = await call({
    command: 'list_threads',
    args: { folder: 'INBOX', limit: 100, ...(cursor ? { cursor } : {}) },
  });
  threads.push(...result.data.threads);
  cursor = result.data.has_more ? result.data.next_cursor : null;
} while (cursor);
i

call é qualquer helper que faz POST de { commands: [...] } para /v1 e retorna results, como em Run Commands.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais 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.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDINVALID_CURSOR

    O cursor está malformado ou pertence a outra conta ou pasta.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.