Base de conhecimento
Linha de comandos
A sua caixa de correio e cada operação da API, a partir de um terminal ou de um script.
Detalhes
- O comando
openemail, instalado a partir do npm como@openemail/cli. É um único ficheiro sem dependências e precisa do Node.js 20.12 ou posterior.npm i -g @openemail/cliinstala-o, enpx @openemail/cli <command>executa-o sem instalação. - Há duas formas de iniciar sessão.
openemail loginabre o seu navegador, onde escolhe o espaço de trabalho, as permissões e quanto tempo dura o acesso, e cada sessão iniciada no navegador é uma aplicação ligada que pode remover em Conta → Aplicações ligadas. Uma chave de API, guardada comopenemail login --with-tokenou definida emOPENEMAIL_API_KEY, nunca abre um navegador nem pede um código, o que a torna adequada para scripts e CI. - Uma sessão iniciada no navegador age em seu nome, por isso uma alteração sensível, como adicionar um webhook ou remover um domínio, pede o mesmo código de verificação que a aplicação web pede. Um código cobre essa sessão durante 60 minutos, e
openemail verifypede-o antes de um script correr. inbox,search,read,replyesendtrabalham a caixa de correio como a aplicação, com a mesma sintaxe de pesquisa, anexos, envios agendados, anulação e tradução.archive,star,snoozee as outras ações sobre conversas aceitam vários identificadores de conversa de uma vez.- Cada método do SDK é um comando,
openemail <resource> <verb>, por isso tudo o que a API REST faz, a linha de comandos também faz.openemail apichama qualquer caminho diretamente, com a mesma sessão. ai translate,ai composeeai summarizelevam as funcionalidades de IA ao terminal.openemail mcp configmostra a configuração para Claude Code, Claude Desktop, Cursor, VS Code, Windsurf e Codex, eopenemail mcp servepermite que esse cliente reutilize a sessão da linha de comandos.- Foi feita para scripts: os dados vão para stdout e tudo o resto para stderr,
--jsonmostra apenas JSON,--allpercorre todas as páginas de uma lista, cada tipo de falha tem o seu próprio código de saída, e nada pergunta em CI nem sem terminal.openemail tempcria uma caixa descartável sem conta nem chave, etemp watch --firstespera pela primeira mensagem. - O que falta: a faturação, criar e mudar de espaço de trabalho, a segurança da conta, a exportação de dados, escrever eventos de calendário, o reencaminhamento e ligar um fornecedor de DNS precisam de uma sessão de navegador, por isso a linha de comandos ainda não os faz, e
openemail openabre em vez disso a página certa da aplicação web. Tal como o SDK, não tem fluxo de publicação, por isso uma versão chega ao npm quando alguém a publica.
