الأوامر

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 هذه الصفحات.