Commands

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

• —Flags go anywhere after the command, before or after the arguments. Global flags such as --profile and --json may also come before it, and any other flag placed there stops with a hint to move it after the command name.
• —A value follows its flag after a space or an equals sign, so --limit 50 and --limit=50 are the same. Short flags take values too, as in -n 50.
• —A value that starts with a dash needs the equals sign, as in --subject=-draft-, because after a space it reads as the next flag and the first one is reported as missing its value. Negative numbers work either way. An empty value is a usage error rather than a quiet default.
• —A switch is on with --flag and off with --no-flag, and --flag=true and --flag=false work too.
• —A list is comma separated or repeated: --to [email protected],[email protected], or --to twice.
• —Everything after -- is an argument and never a flag, which is how a search for -from:ada gets through.
• —An unknown command or flag stops with exit code 2 and suggests the closest match.

These are written for people: they ask for what is missing, format what they print, and combine several API calls where that helps.

Every method of the SDK is also a command, openemail <namespace> <verb>. The namespace is the SDK namespace in kebab case, and the verb is the method name in kebab case, so keys.listRequests is openemail keys list-requests. Together they cover the whole REST API.

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

• —An id the method takes is an argument, as in openemail domains get <id>. Each field of the request body is a flag named after it in kebab case: replyTo is --reply-to, and color.backgroundColor is --color-background-color.
• —Three fields whose flag would clash with a global flag are renamed: --template-version, --label-color and --resend-key.
• —--data takes the whole body as JSON, inline, from a file with @path, or from stdin with -, and any flag you pass as well overrides its key. A flag that takes an object reads JSON the same way.
• —Numbers and switches are read as such, and lists are comma separated or repeated.
• —A missing required value is asked for in a terminal, and is a usage error (exit code 2) anywhere else.
• —A list verb reads one page. --limit sets its size and --cursor carries on from the cursor it printed. --all reads every page and streams the items, --max <n> stops after that many, and --ndjson prints one JSON object per line.
• —Anything destructive, such as deleting, revoking, rotating, cancelling or emptying, asks you to confirm, unless you pass --yes.
• —A download is written to the file in --out, and to stdout only when stdout is not a terminal.

openemail <namespace> <verb> --help shows each argument and flag with its type, the scopes the call needs, its method and path, what it returns, and the notes from the API reference.

Also lists the other names a namespace answers to.

In members and suppressions, whose verbs are add and remove, new and create lead to add, and rm, del and delete lead to remove. A few hand-written subcommands have aliases of their own, which their help lists.

openemail api <method> <path> sends one request to the REST API through the same transport as every other command, so your profile or key, token renewal and verification codes all apply. A path on its own is a GET. A JSON answer prints formatted, and a failed request prints the API error and exits with the matching 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 takes the body as inline JSON, from a file with @path, or from stdin with -. -q, --query and -H, --header take key=value and can be repeated, and -o, --out saves the answer to a file as it came.
• —The path is relative to the API origin. A full URL, a path that would leave the origin and an Authorization header are refused with exit code 2 before anything is sent, because the CLI sets the credential itself.

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

openemail --help lists every command by what it is for. A group lists its subcommands with examples, and a command shows everything it takes. openemail docs open cli opens these pages.