Comandos

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

• —Las opciones van en cualquier lugar después del comando, antes o después de los argumentos. Las opciones globales como --profile y --json también pueden ir antes, y cualquier otra opción puesta ahí se detiene con una indicación para moverla después del nombre del comando.
• —Un valor sigue a su opción tras un espacio o un signo igual, así que --limit 50 y --limit=50 son lo mismo. Las opciones cortas también llevan valores, como en -n 50.
• —Un valor que empieza por un guion necesita el signo igual, como en --subject=-draft-, porque tras un espacio se lee como la siguiente opción y la primera se da por falta de valor. Los números negativos funcionan de las dos formas. Un valor vacío es un error de uso en lugar de un valor por defecto silencioso.
• —Un interruptor se activa con --flag y se desactiva con --no-flag, y --flag=true y --flag=false también funcionan.
• —Una lista va separada por comas o repetida: --to [email protected],[email protected], o --to dos veces.
• —Todo lo que va después de -- es un argumento y nunca una opción, y así pasa una búsqueda de -from:ada.
• —Un comando o una opción desconocidos se detienen con el código de salida 2 y sugieren la coincidencia más cercana.

Están escritos para personas: piden lo que falta, dan formato a lo que muestran y combinan varias llamadas a la API cuando ayuda.

Cada método del SDK es también un comando, openemail <namespace> <verb>. El espacio de nombres es el del SDK en kebab-case, y el verbo es el nombre del método en kebab-case, así que keys.listRequests es openemail keys list-requests. Juntos cubren toda la 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

• —Un id que recibe el método es un argumento, como en openemail domains get <id>. Cada campo del cuerpo de la petición es una opción con su nombre en kebab-case: replyTo es --reply-to, y color.backgroundColor es --color-background-color.
• —Tres campos cuya opción chocaría con una opción global se renombran: --template-version, --label-color y --resend-key.
• —--data recibe el cuerpo entero como JSON, en línea, desde un archivo con @path o desde stdin con -, y cualquier opción que pases además reemplaza su clave. Una opción que recibe un objeto lee JSON de la misma forma.
• —Los números y los interruptores se leen como tales, y las listas van separadas por comas o repetidas.
• —Un valor obligatorio que falta se pregunta en un terminal, y es un error de uso (código de salida 2) en cualquier otro sitio.
• —Un verbo de lista lee una página. --limit fija su tamaño y --cursor sigue desde el cursor que mostró. --all lee cada página y transmite los elementos, --max <n> se detiene tras esa cantidad, y --ndjson muestra un objeto JSON por línea.
• —Cualquier cosa destructiva, como eliminar, revocar, rotar, cancelar o vaciar, pide que confirmes, salvo que pases --yes.
• —Una descarga se escribe en el archivo de --out, y en stdout solo cuando stdout no es un terminal.

openemail <namespace> <verb> --help muestra cada argumento y opción con su tipo, los scopes que necesita la llamada, su método y ruta, lo que devuelve y las notas de la referencia de la API.

También lista los otros nombres a los que responde un espacio de nombres.

En members y suppressions, cuyos verbos son add y remove, new y create llevan a add, y rm, del y delete llevan a remove. Algunos subcomandos escritos a mano tienen sus propios alias, que su ayuda indica.

openemail api <method> <path> envía una solicitud a la API REST por el mismo transporte que cualquier otro comando, así que se aplican tu perfil o tu clave, la renovación del token y los códigos de verificación. Una ruta sola es un GET. Una respuesta JSON se muestra formateada, y una solicitud fallida muestra el error de la API y termina con el código correspondiente.

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 toma el cuerpo como JSON en línea, desde un archivo con @path o desde stdin con -. -q, --query y -H, --header toman key=value y se pueden repetir, y -o, --out guarda la respuesta tal cual en un archivo.
• —La ruta es relativa al origen de la API. Una URL completa, una ruta que saldría del origen y una cabecera Authorization se rechazan con el código de salida 2 antes de enviar nada, porque la CLI pone la credencial ella misma.

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

openemail --help lista cada comando según para qué sirve. Un grupo lista sus subcomandos con ejemplos, y un comando muestra todo lo que recibe. openemail docs open cli abre estas páginas.