Comandos

openemail <command> [subcommand] [arguments] [flags]

• —As opções ficam em qualquer lugar depois do comando, antes ou depois dos argumentos. As opções globais como --profile e --json também podem vir antes dele, e qualquer outra opção colocada aí para com uma indicação para a mover para depois do nome do comando.
• —Um valor segue a sua opção depois de um espaço ou de um sinal de igual, por isso --limit 50 e --limit=50 são o mesmo. As opções curtas também aceitam valores, como em -n 50.
• —Um valor que começa por um hífen precisa do sinal de igual, como em --subject=-draft-, porque depois de um espaço é lido como a opção seguinte e a primeira é dada como sem valor. Os números negativos funcionam das duas formas. Um valor vazio é um erro de utilização em vez de um valor predefinido silencioso.
• —Um interruptor liga-se com --flag e desliga-se com --no-flag, e --flag=true e --flag=false também funcionam.
• —Uma lista é separada por vírgulas ou repetida: --to [email protected],[email protected], ou --to duas vezes.
• —Tudo o que vem depois de -- é um argumento e nunca uma opção, e é assim que passa uma pesquisa por -from:ada.
• —Um comando ou uma opção desconhecidos param com o código de saída 2 e sugerem a correspondência mais próxima.

São escritos para pessoas: pedem o que falta, formatam o que mostram e combinam várias chamadas à API quando isso ajuda.

Cada método do SDK é também um comando, openemail <namespace> <verb>. O espaço de nomes é o do SDK em kebab-case, e o verbo é o nome do método em kebab-case, por isso keys.listRequests é openemail keys list-requests. Juntos cobrem toda a API REST.

openemail domains listopenemail domains create --domain acme.comopenemail rules create --data @rule.jsonopenemail keys list-requests 9f2c1a4b7e05d3862c1f0a44 --failed-only --allopenemail files download file_6bb640f5b99e47deb758f1f5 --out report.pdf

• —Um id que o método recebe é um argumento, como em openemail domains get <id>. Cada campo do corpo do pedido é uma opção com o nome dele em kebab-case: replyTo é --reply-to, e color.backgroundColor é --color-background-color.
• —Três campos cuja opção entraria em conflito com uma opção global têm outro nome: --template-version, --label-color e --resend-key.
• —--data recebe o corpo inteiro como JSON, em linha, de um ficheiro com @path ou de stdin com -, e qualquer opção que passe também substitui a respetiva chave. Uma opção que recebe um objeto lê JSON da mesma forma.
• —Os números e os interruptores são lidos como tal, e as listas são separadas por vírgulas ou repetidas.
• —Um valor obrigatório em falta é pedido num terminal, e é um erro de utilização (código de saída 2) em qualquer outro lado.
• —Um verbo de lista lê uma página. --limit define o seu tamanho e --cursor continua a partir do cursor que mostrou. --all lê cada página e transmite os itens, --max <n> para depois desse número, e --ndjson mostra um objeto JSON por linha.
• —Qualquer coisa destrutiva, como eliminar, revogar, rodar, cancelar ou esvaziar, pede-lhe confirmação, a menos que passe --yes.
• —Uma transferência é escrita no ficheiro de --out, e em stdout só quando stdout não é um terminal.

openemail <namespace> <verb> --help mostra cada argumento e opção com o seu tipo, os scopes de que a chamada precisa, o método e o caminho, o que devolve e as notas da referência da API.

Também lista os outros nomes a que um espaço de nomes responde.

Em members e suppressions, cujos verbos são add e remove, new e create levam a add, e rm, del e delete levam a remove. Alguns subcomandos escritos à mão têm os seus próprios alias, que a respetiva ajuda indica.

openemail api <method> <path> envia um pedido à API REST pelo mesmo transporte que qualquer outro comando, por isso aplicam-se o seu perfil ou chave, a renovação do token e os códigos de verificação. Um caminho sozinho é um GET. Uma resposta JSON é mostrada formatada, e um pedido falhado mostra o erro da API e termina com o código correspondente.

openemail api /keys/selfopenemail api GET /threads --query folder=inbox --query limit=5openemail api POST /labels --data '{"name":"Receipts"}'openemail api PATCH /threads/CAHk7pQ2x9LmZ4 --data @patch.jsonopenemail api GET /files/file_6bb640f5b99e47deb758f1f5/content --out report.pdf

• —-d, --data recebe o corpo como JSON em linha, de um ficheiro com @path, ou de stdin com -. -q, --query e -H, --header recebem key=value e podem repetir-se, e -o, --out guarda a resposta tal como veio num ficheiro.
• —O caminho é relativo à origem da API. Um URL completo, um caminho que sairia da origem e um cabeçalho Authorization são recusados com o código de saída 2 antes de enviar alguma coisa, porque a CLI define a credencial ela própria.

openemail --helpopenemail help sendopenemail domains --helpopenemail domains create --help

openemail --help lista cada comando pelo que serve. Um grupo lista os seus subcomandos com exemplos, e um comando mostra tudo o que recebe. openemail docs open cli abre estas páginas.