Axuz Developers

GET /messages/{messageId}

Lê mensagem + thread completa + anexos

  • 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 /messages/:messageId. Retorna a mensagem foco, toda a thread (mesmo thread_id na mesma account) e os anexos. Gate via ownsAccount. Motivo: painel de leitura do webmail precisa da thread inteira num único fetch.

Parâmetros

NomeEmTipoObrigatórioDescrição
messageIdpathstringsim

Respostas

200

Foco + thread + anexos

NomeTipoObrigatórioDescrição
messageMailMessagesim
message.idstring<uuid>sim
message.account_idstring<uuid>sim
message.folder_idstring<uuid>sim
message.thread_idstring<uuid>sim
message.in_reply_tostring<uuid> | nullnão
message.from_emailstring<email>sim
message.from_namestringnão
message.to_emailsarray<string<email>>sim
message.cc_emailsarray<string<email>>não
message.bcc_emailsarray<string<email>>não
message.subjectstringsim
message.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.

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

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

message.internalbooleansim
message.created_atstring<date-time>sim
message.updated_atstring<date-time>sim
threadarray<MailMessage>sim
thread[].idstring<uuid>sim
thread[].account_idstring<uuid>sim
thread[].folder_idstring<uuid>sim
thread[].thread_idstring<uuid>sim
thread[].in_reply_tostring<uuid> | nullnão
thread[].from_emailstring<email>sim
thread[].from_namestringnão
thread[].to_emailsarray<string<email>>sim
thread[].cc_emailsarray<string<email>>não
thread[].bcc_emailsarray<string<email>>não
thread[].subjectstringsim
thread[].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.

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

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

thread[].internalbooleansim
thread[].created_atstring<date-time>sim
thread[].updated_atstring<date-time>sim
attachmentsarray<MailAttachment>sim
attachments[].idstring<uuid>sim
attachments[].message_idstring<uuid>sim
attachments[].filenamestringsim
attachments[].content_typestringnão
attachments[].size_bytesintegersim
attachments[].file_idstring<uuid> | nullnão

400

ID inválido

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é dono

404

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/messages/MESSAGE_ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://mail-api.axuz.net/messages/MESSAGE_ID", {
  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/messages/MESSAGE_ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())