فرمان‌ها

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 هر آرگومان و پرچم را با نوعش، دامنه‌های مجوزی که فراخوانی لازم دارد، متد و مسیر آن، آنچه برمی‌گرداند و یادداشت‌های مرجع 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 است. نشانی کامل، مسیری که از مبدأ بیرون برود و سرآیند Authorization پیش از فرستادن هر چیزی با کد خروج 2 رد می‌شوند، چون CLI اعتبارنامه را خودش تنظیم می‌کند.

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

openemail --help هر فرمان را بر اساس کاربردش فهرست می‌کند. یک گروه زیرفرمان‌هایش را با نمونه فهرست می‌کند و یک فرمان هر چه را می‌گیرد نشان می‌دهد. openemail docs open cli این صفحه‌ها را باز می‌کند.