Befehle

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

• —Flags stehen irgendwo nach dem Befehl, vor oder nach den Argumenten. Globale Flags wie --profile und --json dürfen auch davor stehen, und jedes andere Flag an dieser Stelle bricht mit dem Hinweis ab, es hinter den Befehlsnamen zu setzen.
• —Ein Wert folgt seinem Flag nach einem Leerzeichen oder einem Gleichheitszeichen, --limit 50 und --limit=50 sind also dasselbe. Kurze Flags nehmen auch Werte, wie in -n 50.
• —Ein Wert, der mit einem Bindestrich beginnt, braucht das Gleichheitszeichen, wie in --subject=-draft-, denn nach einem Leerzeichen gilt er als nächstes Flag, und dem ersten wird ein fehlender Wert gemeldet. Negative Zahlen funktionieren auf beide Arten. Ein leerer Wert ist ein Nutzungsfehler statt eines stillen Standardwerts.
• —Ein Schalter ist mit --flag an und mit --no-flag aus, und --flag=true und --flag=false funktionieren auch.
• —Eine Liste ist durch Kommas getrennt oder wiederholt: --to [email protected],[email protected], oder --to zweimal.
• —Alles nach -- ist ein Argument und nie ein Flag, so kommt eine Suche nach -from:ada durch.
• —Ein unbekannter Befehl oder ein unbekanntes Flag bricht mit Exit-Code 2 ab und schlägt den nächsten Treffer vor.

Diese sind für Menschen geschrieben: Sie fragen nach Fehlendem, formatieren ihre Ausgabe und kombinieren mehrere API-Aufrufe, wo das hilft.

Jede Methode des SDK ist auch ein Befehl, openemail <namespace> <verb>. Der Namespace ist der SDK-Namespace in Kebab-Case, und das Verb ist der Methodenname in Kebab-Case, keys.listRequests ist also openemail keys list-requests. Zusammen decken sie die ganze REST API ab.

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

• —Eine ID, die die Methode nimmt, ist ein Argument, wie in openemail domains get <id>. Jedes Feld des Request-Bodys ist ein Flag, benannt nach dem Feld in Kebab-Case: replyTo ist --reply-to, und color.backgroundColor ist --color-background-color.
• —Drei Felder, deren Flag mit einem globalen Flag kollidieren würde, sind umbenannt: --template-version, --label-color und --resend-key.
• —--data nimmt den ganzen Body als JSON, inline, aus einer Datei mit @path oder von stdin mit -, und jedes Flag, das Sie zusätzlich übergeben, überschreibt seinen Schlüssel. Ein Flag, das ein Objekt nimmt, liest JSON auf dieselbe Weise.
• —Zahlen und Schalter werden als solche gelesen, und Listen sind durch Kommas getrennt oder wiederholt.
• —Ein fehlender Pflichtwert wird in einem Terminal abgefragt und ist überall sonst ein Nutzungsfehler (Exit-Code 2).
• —Ein List-Verb liest eine Seite. --limit legt ihre Größe fest und --cursor macht beim ausgegebenen Cursor weiter. --all liest jede Seite und streamt die Einträge, --max <n> hört nach so vielen auf, und --ndjson gibt ein JSON-Objekt pro Zeile aus.
• —Alles Destruktive, etwa Löschen, Widerrufen, Rotieren, Abbrechen oder Leeren, bittet um Bestätigung, außer Sie übergeben --yes.
• —Ein Download wird in die Datei aus --out geschrieben, und nur dann auf stdout, wenn stdout kein Terminal ist.

openemail <namespace> <verb> --help zeigt jedes Argument und Flag mit seinem Typ, die Scopes, die der Aufruf braucht, Methode und Pfad, was er zurückgibt, und die Hinweise aus der API-Referenz.

Auch nennt die anderen Namen, auf die ein Namespace hört.

In members und suppressions, deren Verben add und remove heißen, führen new und create zu add, und rm, del und delete zu remove. Einige handgeschriebene Unterbefehle haben eigene Aliasse, die ihre Hilfe nennt.

openemail api <method> <path> sendet eine Anfrage an die REST API über denselben Transport wie jeder andere Befehl, sodass Ihr Profil oder Schlüssel, die Token-Erneuerung und Bestätigungscodes gelten. Ein Pfad allein ist ein GET. Eine JSON-Antwort wird formatiert ausgegeben, und eine fehlgeschlagene Anfrage gibt den API-Fehler aus und endet mit dem passenden Exit-Code.

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 nimmt den Body als Inline-JSON, aus einer Datei mit @path oder von stdin mit -. -q, --query und -H, --header nehmen key=value und lassen sich wiederholen, und -o, --out speichert die Antwort unverändert in einer Datei.
• —Der Pfad ist relativ zum API-Ursprung. Eine vollständige URL, ein Pfad, der den Ursprung verlassen würde, und ein Authorization-Header werden mit Exit-Code 2 abgelehnt, bevor etwas gesendet wird, denn die CLI setzt die Anmeldedaten selbst.

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

openemail --help listet jeden Befehl nach seinem Zweck. Eine Gruppe listet ihre Unterbefehle mit Beispielen, und ein Befehl zeigt alles, was er nimmt. openemail docs open cli öffnet diese Seiten.