Receber e-mails: Leitura

Buscar

Busque na caixa de correio por remetente, domínio, assunto, corpo ou marcador, com os mesmos operadores da caixa de busca do webmail.

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

Sem field, a busca é automática: um endereço de e-mail completo busca pelo remetente exato, domain.com busca pelo domínio e qualquer outra coisa busca no assunto, no corpo e no nome do remetente.

i

Com operadores (from:, is:unread…) os resultados são agrupados por conversa: uma linha por thread, com a mensagem mais recente que bateu. Sem in:, Spam e Lixeira ficam de fora.

Argumentos

  • querystringobrigatório

    O que buscar, até 256 caracteres. Com várias palavras, a primeira vem do índice e as outras filtram pelo assunto e pela prévia.

  • fieldstringopcional

    Limita uma busca simples a from, to, subject, body, sender ou label. Ignorado quando a consulta tem operadores.

  • limitnumberopcional

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

  • cursorstringopcional

    O next_cursor da página anterior.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "search",
        args: {
          query: "ana@client.com",
          field: "from",
          limit: 5
        }
      }
    ]
  },
  { 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": "search",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "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"
            ],
            "is_read": false,
            "is_starred": false,
            "is_important": false,
            "received_at": "2026-10-09T14:21:07Z"
          }
        ],
        "has_more": false,
        "next_cursor": null
      }
    }
  ]
}

Campos da resposta

  • messages[]

    Mensagens que batem, da mais recente para a mais antiga. Cada uma tem message_uid, thread_id, subject, preview, from_name, from_email, folders, as flags de lida/estrela/importante e received_at.

  • has_more / next_cursor

    Paginação.

Operadores

Misture-os com palavras simples. Um valor com espaços vai entre aspas: subject:"new proposal". Coloque - na frente para excluir: -from:noreply, -newsletter.

Body da requisição

{
  "commands": [
    {
      "command": "search",
      "args": {
        "query": "from:ana@client.com has:attachment newer_than:30d invoice"
      }
    }
  ]
}
  • from: / to:

    Remetente / destinatário (to ou cc), parte do nome ou do endereço.

  • subject: / label:

    Texto do assunto / um marcador.

  • in:

    inbox, sent, archive, trash, spam, drafts, promotions, snoozed, scheduled, agents, not-subscribing ou o id de uma pasta personalizada.

  • has:attachment

    Só mensagens com anexos.

  • is:unread / is:read / is:starred / is:important

    Estado da mensagem.

  • after: / before:

    Uma data YYYY/MM/DD (ou YYYY-MM-DD), UTC.

  • newer_than: / older_than:

    7d, 2w, 3m (30 dias) ou 1y.

i

Só filtros, sem palavra para buscar (is:unread in:archive), retornam threads (a lista de conversas daquela pasta) em vez de messages.

Exemplos de busca

Bodies da requisição

// subject + body + sender name
{
  "commands": [
    {
      "command": "search",
      "args": {
        "query": "invoice september"
      }
    }
  ]
}

// exact sender
{
  "commands": [
    {
      "command": "search",
      "args": {
        "query": "ana@client.com",
        "field": "from"
      }
    }
  ]
}

// everyone from a domain
{
  "commands": [
    {
      "command": "search",
      "args": {
        "query": "client.com"
      }
    }
  ]
}

// messages with a label
{
  "commands": [
    {
      "command": "search",
      "args": {
        "query": "cliente-vip",
        "field": "label"
      }
    }
  ]
}

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.