कमांड

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>। नेमस्पेस kebab case में SDK नेमस्पेस है, और वर्ब 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

• —मेथड जो ID लेता है वह एक आर्ग्युमेंट है, जैसे 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 ओरिजिन के सापेक्ष है। पूरा URL, ओरिजिन से बाहर जाने वाला पाथ और Authorization हेडर कुछ भी भेजे जाने से पहले एग्ज़िट कोड 2 के साथ अस्वीकार होते हैं, क्योंकि क्रेडेंशियल CLI ख़ुद सेट करती है।

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

openemail --help हर कमांड को उसके काम के हिसाब से दिखाता है। ग्रुप अपनी सबकमांड उदाहरणों के साथ दिखाता है, और कमांड वह सब दिखाती है जो वह लेती है। openemail docs open cli ये पेज खोलता है।