Commandes

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

• —Les options se placent n'importe où après la commande, avant ou après les arguments. Les options globales comme --profile et --json peuvent aussi venir avant elle, et toute autre option placée là s'arrête avec une indication pour la déplacer après le nom de la commande.
• —Une valeur suit son option après une espace ou un signe égal, donc --limit 50 et --limit=50 reviennent au même. Les options courtes prennent aussi des valeurs, comme dans -n 50.
• —Une valeur qui commence par un tiret exige le signe égal, comme dans --subject=-draft-, car après une espace elle se lit comme l'option suivante et la première est signalée comme sans valeur. Les nombres négatifs fonctionnent dans les deux cas. Une valeur vide est une erreur d'utilisation plutôt qu'une valeur par défaut discrète.
• —Un interrupteur s'active avec --flag et se désactive avec --no-flag, et --flag=true et --flag=false fonctionnent aussi.
• —Une liste est séparée par des virgules ou répétée : --to [email protected],[email protected], ou --to deux fois.
• —Tout ce qui suit -- est un argument et jamais une option, c'est ainsi qu'une recherche de -from:ada passe.
• —Une commande ou une option inconnue s'arrête avec le code de sortie 2 et suggère la correspondance la plus proche.

Elles sont écrites pour des personnes : elles demandent ce qui manque, mettent en forme ce qu'elles affichent et combinent plusieurs appels d'API quand cela aide.

Chaque méthode du SDK est aussi une commande, openemail <namespace> <verb>. L'espace de noms est celui du SDK en kebab-case, et le verbe est le nom de la méthode en kebab-case, donc keys.listRequests devient openemail keys list-requests. Ensemble, elles couvrent toute l'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 identifiant que prend la méthode est un argument, comme dans openemail domains get <id>. Chaque champ du corps de la requête est une option qui porte son nom en kebab-case : replyTo devient --reply-to, et color.backgroundColor devient --color-background-color.
• —Trois champs dont l'option entrerait en conflit avec une option globale sont renommés : --template-version, --label-color et --resend-key.
• —--data prend tout le corps en JSON, en ligne, depuis un fichier avec @path ou depuis stdin avec -, et toute option passée en plus remplace sa clé. Une option qui prend un objet lit le JSON de la même façon.
• —Les nombres et les interrupteurs sont lus comme tels, et les listes sont séparées par des virgules ou répétées.
• —Une valeur obligatoire manquante est demandée dans un terminal, et constitue une erreur d'utilisation (code de sortie 2) partout ailleurs.
• —Un verbe de liste lit une page. --limit fixe sa taille et --cursor reprend au curseur qu'il a affiché. --all lit chaque page et diffuse les éléments, --max <n> s'arrête après autant d'éléments, et --ndjson affiche un objet JSON par ligne.
• —Toute action destructrice, comme supprimer, révoquer, faire tourner, annuler ou vider, vous demande confirmation, sauf si vous passez --yes.
• —Un téléchargement est écrit dans le fichier indiqué par --out, et sur stdout seulement quand stdout n'est pas un terminal.

openemail <namespace> <verb> --help montre chaque argument et option avec son type, les scopes dont l'appel a besoin, sa méthode et son chemin, ce qu'il renvoie, et les notes de la référence de l'API.

Aussi liste les autres noms auxquels un espace de noms répond.

Dans members et suppressions, dont les verbes sont add et remove, new et create mènent à add, et rm, del et delete mènent à remove. Quelques sous-commandes écrites à la main ont leurs propres alias, que leur aide indique.

openemail api <method> <path> envoie une requête à l'API REST par le même transport que toutes les autres commandes, donc votre profil ou votre clé, le renouvellement du jeton et les codes de vérification s'appliquent tous. Un chemin seul est un GET. Une réponse JSON s'affiche formatée, et une requête en échec affiche l'erreur de l'API et se termine avec le code correspondant.

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 prend le corps en JSON en ligne, depuis un fichier avec @path, ou depuis stdin avec -. -q, --query et -H, --header prennent key=value et peuvent être répétées, et -o, --out enregistre la réponse telle quelle dans un fichier.
• —Le chemin est relatif à l'origine de l'API. Une URL complète, un chemin qui sortirait de l'origine et un en-tête Authorization sont refusés avec le code de sortie 2 avant tout envoi, car la CLI fixe elle-même l'identifiant.

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

openemail --help liste chaque commande selon son usage. Un groupe liste ses sous-commandes avec des exemples, et une commande montre tout ce qu'elle prend. openemail docs open cli ouvre ces pages.