email_inbox.test

Testar a conexão de uma caixa já conectada. Testa o recebimento (IMAP) e o envio (SMTP) com as credenciais guardadas e devolve o resultado de cada um. O estado da caixa acompanha: sucesso limpa o "falhando desde"; falha o marca. Senha ilegível dá credential_unreadable nas duas pontas (informe a senha de novo em email_inbox.update_credentials).

• Endpoint: POST https://app.atomiks.com.br/api/v1/email_inbox.test (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: channels:write
• Grava dados: sim
• Pela chave de API: sim
• Ferramenta MCP: email_inbox_test
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId email_inbox.test)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/email_inbox.test \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs email_inbox.test --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta email_inbox_test com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "imap": {
      "type": "object",
      "properties": {
        "ok": {
          "type": "boolean"
        },
        "errorCode": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "ok",
        "errorCode"
      ],
      "additionalProperties": false
    },
    "smtp": {
      "type": "object",
      "properties": {
        "ok": {
          "type": "boolean"
        },
        "errorCode": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "ok",
        "errorCode"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "imap",
    "smtp"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).