email_inbox.create

Conectar uma caixa de e-mail. Testa o recebimento (IMAP) e o envio (SMTP); se os dois passam, cria o canal email ativo e guarda as senhas cifradas. Falha no teste: invalid_input com EMAIL_IMAP_FAILED:<código> ou EMAIL_SMTP_FAILED:<código> e nada é criado. Caixa já conectada nesta conta: limit_reached com CHANNEL_ALREADY_CONNECTED; conectada em outra conta: limit_reached com CHANNEL_HELD_ELSEWHERE, e confirmTakeover: true desconecta a outra e move para cá. A leitura começa dali em diante (o que já estava na caixa só entra por email_inbox.history_import). Exige TOKEN_ENC_KEY no servidor (senão credencial_ausente) e a migration (senão migration_pendente).

• Endpoint: POST https://app.atomiks.com.br/api/v1/email_inbox.create (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_create
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId email_inbox.create)

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
    },
    "confirmTakeover": {
      "default": false,
      "type": "boolean"
    }
  },
  "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.create \
  -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","confirmTakeover":false}'

CLI:

node cli/atomiks.mjs email_inbox.create --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","confirmTakeover":false}'

MCP: ferramenta email_inbox_create com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "channelInstanceId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "const": "live"
    }
  },
  "required": [
    "id",
    "channelInstanceId",
    "status"
  ],
  "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).