Команды

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

• —Флаги ставятся где угодно после команды, до или после аргументов. Глобальные флаги вроде --profile и --json можно ставить и перед ней, а любой другой флаг в этом месте останавливает команду с подсказкой перенести его после имени команды.
• —Значение идёт за флагом через пробел или знак равенства, поэтому --limit 50 и --limit=50 одно и то же. Короткие флаги тоже принимают значения, как в -n 50.
• —Значению, которое начинается с дефиса, нужен знак равенства, как в --subject=-draft-, потому что после пробела оно читается как следующий флаг, а о первом сообщается, что у него нет значения. Отрицательные числа работают в обоих случаях. Пустое значение считается ошибкой использования, а не тихим значением по умолчанию.
• —Переключатель включается через --flag и выключается через --no-flag, а --flag=true и --flag=false тоже работают.
• —Список пишется через запятую или повторением: --to [email protected],[email protected] или --to дважды.
• —Всё после -- это аргумент и никогда не флаг; так проходит поиск по -from:ada.
• —Неизвестная команда или флаг завершается с кодом выхода 2 и предлагает ближайшее совпадение.

Они написаны для людей: спрашивают недостающее, форматируют вывод и объединяют несколько вызовов API, где это помогает.

Каждый метод SDK это ещё и команда, openemail <namespace> <verb>. Пространство имён это пространство имён SDK в kebab-case, а глагол это имя метода в kebab-case, поэтому keys.listRequests становится openemail keys list-requests. Вместе они покрывают весь 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

• —Идентификатор, который принимает метод, это аргумент, как в openemail domains get <id>. Каждое поле тела запроса это флаг с его именем в kebab-case: replyTo становится --reply-to, а color.backgroundColor становится --color-background-color.
• —Три поля, флаг которых конфликтовал бы с глобальным флагом, переименованы: --template-version, --label-color и --resend-key.
• —--data принимает всё тело в виде JSON: встроенно, из файла через @path или из stdin через -, а любой флаг, переданный вдобавок, переопределяет свой ключ. Флаг, принимающий объект, читает JSON так же.
• —Числа и переключатели читаются как таковые, а списки пишутся через запятую или повторением.
• —Отсутствующее обязательное значение запрашивается в терминале, а везде ещё это ошибка использования (код выхода 2).
• —Глагол списка читает одну страницу. --limit задаёт её размер, а --cursor продолжает с выведенного курсора. --all читает все страницы и передаёт элементы потоком, --max <n> останавливается после стольких, а --ndjson выводит по одному JSON-объекту в строке.
• —Всё разрушительное, например удаление, отзыв, ротация, отмена или очистка, просит подтверждения, если вы не передадите --yes.
• —Загрузка записывается в файл из --out, а в stdout только тогда, когда stdout не терминал.

openemail <namespace> <verb> --help показывает каждый аргумент и флаг с типом, scope, которые нужны вызову, его метод и путь, что он возвращает, и примечания из справочника API.

Столбец «Также» перечисляет другие имена, на которые откликается пространство имён.

В members и suppressions, где глаголы называются add и remove, new и create ведут к add, а rm, del и delete ведут к remove. У некоторых написанных вручную подкоманд есть свои псевдонимы, их перечисляет справка.

openemail api <method> <path> отправляет один запрос в REST API через тот же транспорт, что и любая другая команда, поэтому действуют ваш профиль или ключ, обновление токена и коды подтверждения. Путь сам по себе означает GET. Ответ в JSON выводится отформатированным, а неудачный запрос выводит ошибку API и завершается соответствующим кодом.

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 принимает тело как встроенный JSON, из файла через @path или из stdin через -. -q, --query и -H, --header принимают key=value и могут повторяться, а -o, --out сохраняет ответ в файл как есть.
• —Путь указывается относительно адреса API. Полный URL, путь, который вышел бы за пределы адреса, и заголовок Authorization отклоняются с кодом выхода 2 до любой отправки, потому что CLI сама подставляет учётные данные.

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

openemail --help перечисляет каждую команду по назначению. Группа перечисляет свои подкоманды с примерами, а команда показывает всё, что принимает. openemail docs open cli открывает эти страницы.