Axuz Developers

GET /accounts/{accountId}/messages

Lista mensagens de uma folder da conta

  • Acesso: Login
  • Serviço: https://mail-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— GET /accounts/:accountId/messages?folder=<kind>&q=&unread=&limit=. Motivo: alimentar a lista lateral do webmail. Comportamento: verifica ownership da conta; resolve folder por kind (inbox default); aplica busca ILIKE em subject/body/from + filtro unread. Limit clamp 1..200 (default 50). Efeitos: só leitura em mail_folders + mail_messages. Ordem: received_at DESC.

Parâmetros

NomeEmTipoObrigatórioDescrição
accountIdpathstringsim
folderquerystringnão

kind da folder (default inbox)

qquerystringnão

Busca ILIKE em subject/body_text/from_email

unreadquerystringnão

Filtra por não-lidas

limitqueryintegernão

Respostas

200

Coleção (received_at DESC)

NomeTipoObrigatórioDescrição
itemsarray<MailMessage>não
items[].idstring<uuid>sim
items[].account_idstring<uuid>sim
items[].folder_idstring<uuid>sim
items[].thread_idstring<uuid>sim
items[].in_reply_tostring<uuid> | nullnão
items[].from_emailstring<email>sim
items[].from_namestringnão
items[].to_emailsarray<string<email>>sim
items[].cc_emailsarray<string<email>>não
items[].bcc_emailsarray<string<email>>não
items[].subjectstringsim
items[].body_htmlstringnão

Corpo HTML sanitizado (allowlist bluemonday, internal/sanitize). Toda leitura passa pelo mesmo chokepoint (scanMessage), então este campo nunca carrega <script>, atributos on*, javascript:, <iframe>, <object> ou <svg>. A COLUNA homônima no banco guarda o corpo cru (forense) e NÃO é confiável — ela nunca sai pela API.

items[].body_textstringnão
items[].readbooleansim
items[].starredbooleansim
items[].labelsarray<string>não
items[].received_atstring<date-time>sim
items[].sent_atstring<date-time> | nullnão
items[].statusstringsim

enum: "draft", "sent", "received", "queued"

items[].internalbooleansim
items[].created_atstring<date-time>sim
items[].updated_atstring<date-time>sim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é dono da conta

404

Folder não achada

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://mail-api.axuz.net/accounts/ACCOUNT_ID/messages' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://mail-api.axuz.net/accounts/ACCOUNT_ID/messages", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://mail-api.axuz.net/accounts/ACCOUNT_ID/messages",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())