email_inbox.test_settings

Testar as credenciais de uma caixa antes de conectar. Abre uma conexão IMAP (recebimento) e uma SMTP (envio) com os dados informados e devolve o resultado de cada uma: ok ou errorCode (auth_failed, host_not_found, connection_refused, tls_error, timeout, host_not_allowed, credential_unreadable, unknown). Nada é salvo. Só servidores públicos de e-mail (rede interna dá host_not_allowed). Limite de 20 testes por conta a cada 10 minutos (limit_reached).

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "emailAddress": {
      "type": "string",
      "maxLength": 254,
      "pattern": "^[^\\s@<>\"]+@[^\\s@<>\"]+\\.[^\\s@<>\"]{2,}$"
    },
    "imapHost": {
      "type": "string",
      "minLength": 1,
      "maxLength": 253,
      "pattern": "^[A-Za-z0-9]([A-Za-z0-9.-]*[A-Za-z0-9])?$"
    },
    "imapPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "imapSecure": {
      "type": "boolean"
    },
    "imapUsername": {
      "type": "string",
      "minLength": 1,
      "maxLength": 254
    },
    "imapPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024
    },
    "smtpHost": {
      "type": "string",
      "minLength": 1,
      "maxLength": 253,
      "pattern": "^[A-Za-z0-9]([A-Za-z0-9.-]*[A-Za-z0-9])?$"
    },
    "smtpPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "smtpSecure": {
      "type": "boolean"
    },
    "smtpUsername": {
      "type": "string",
      "minLength": 1,
      "maxLength": 254
    },
    "smtpPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024
    }
  },
  "required": [
    "emailAddress",
    "imapHost",
    "imapPort",
    "imapSecure",
    "imapUsername",
    "imapPassword",
    "smtpHost",
    "smtpPort",
    "smtpSecure",
    "smtpUsername",
    "smtpPassword"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/email_inbox.test_settings \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emailAddress":"[email protected]","imapHost":"imap.gmail.com","imapPort":993,"imapSecure":true,"imapUsername":"[email protected]","imapPassword":"senha-de-app","smtpHost":"smtp.gmail.com","smtpPort":465,"smtpSecure":true,"smtpUsername":"[email protected]","smtpPassword":"senha-de-app"}'

CLI:

node cli/atomiks.mjs email_inbox.test_settings --json '{"emailAddress":"[email protected]","imapHost":"imap.gmail.com","imapPort":993,"imapSecure":true,"imapUsername":"[email protected]","imapPassword":"senha-de-app","smtpHost":"smtp.gmail.com","smtpPort":465,"smtpSecure":true,"smtpUsername":"[email protected]","smtpPassword":"senha-de-app"}'

MCP: ferramenta email_inbox_test_settings 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).