Voltar ao início

Documentação

Três formas de interagir com o seu email

Quer esteja a construir agentes de IA, a automatizar workflows ou a integrar email no seu produto — escolha a interface que se adapta ao seu stack.

A interface universal

REST API

Uma API RESTful limpa que normaliza todos os fornecedores de email numa única interface consistente. Envie, leia, pesquise e gira email entre Gmail, Outlook e qualquer fornecedor IMAP — tudo através de um endpoint.

  • Endpoint unificado para todos os fornecedores
  • Corpos de pedido e resposta em JSON
  • Autenticação por Bearer token
  • Paginação, filtragem e pesquisa full-text
  • Subscrições de webhooks para eventos em tempo real
  • Documentação OpenAPI/Swagger incluída
Enviar um email
curl -X POST https://api.inbox-api.com/v1/send \
  -H 'Authorization: Bearer tok_...' \
  -H 'Content-Type: application/json' \
  -d '{"to": "team@acme.com", "subject": "Q3 Report", "body": "<h1>Hello</h1>"}'
Pesquisar mensagens
curl https://api.inbox-api.com/v1/messages?q=invoice \
  -H 'Authorization: Bearer tok_...'

// Resposta
{
  "messages": [
    {
      "id": "msg_abc123",
      "from": "billing@vendor.com",
      "subject": "Invoice #1042",
      "snippet": "Please find attached...",
      "date": "2026-03-20T14:30:00Z",
      "hasAttachments": true
    }
  ],
  "nextCursor": "cur_xyz789"
}
Feito para agentes de IA

Servidor MCP

Suporte nativo ao Model Context Protocol significa que o Claude, GPT e qualquer agente compatível com MCP pode ler, enviar e gerir email através de ferramentas standard — sem código de integração, sem exposição de credenciais.

  • Interface de ferramentas MCP standard
  • Funciona com Claude, GPT e qualquer cliente MCP
  • Permissões granulares por agente
  • Conversas com contexto de thread
  • Pesquisa em todas as contas ligadas
  • Zero exposição de credenciais aos LLMs
Configuração
// claude_desktop_config.json
{
  "mcpServers": {
    "inbox-api": {
      "command": "npx",
      "args": ["inbox-api-mcp"],
      "env": {
        "INBOX_API_TOKEN": "tok_..."
      }
    }
  }
}
Ferramentas disponíveis
// Ferramentas MCP disponíveis
list_messages    — Pesquisar e listar emails entre contas
get_message      — Ler um email completo com anexos
get_thread       — Obter uma conversa completa
send_email       — Compor e enviar um novo email
reply            — Responder a uma mensagem existente
create_draft     — Guardar um rascunho para revisão
search           — Pesquisa full-text em todas as contas
archive          — Arquivar ou mover mensagens
Para automação e scripting

CLI

Uma interface de linha de comandos completa para gerir contas de email, enviar mensagens e automatizar workflows. Output compatível com pipes, comandos scriptáveis e autocompletar incluído.

  • Gira contas e tokens a partir do terminal
  • Envie e leia email com comandos simples
  • Output JSON para scripting e pipelines
  • Autocompletar para bash, zsh e fish
  • Compatível com cron para tarefas agendadas
  • Configure webhooks e definições de sync
Terminal
# Adicionar uma conta de email
$ inbox-api accounts add --provider gmail --email me@gmail.com

# Criar um token com permissões
$ inbox-api tokens create --name "my-agent" --scopes read,send

# Pesquisar a caixa de entrada
$ inbox-api messages list --query "from:boss@company.com" --json

# Enviar um email
$ inbox-api send --to team@acme.com --subject "Update" --body "Tudo feito."
Disponível no lançamento

Seja o primeiro a saber quando lançarmos

Entrar na lista de espera