स्क्रिप्टिंग

--json के साथ stdout में सिर्फ़ JSON होता है, दो स्पेस की इंडेंटेशन के साथ, नोट और प्रगति stderr पर रहते हैं, और कुछ भी पूछा नहीं जाता। सूची { items, hasMore, nextCursor } प्रिंट करती है, API ऑब्जेक्ट वैसा ही प्रिंट होता है जैसा API ने लौटाया, और हाथ से लिखी कमांड वह ऑब्जेक्ट प्रिंट करती है जिसका वर्णन उसकी मदद में है।

openemail whoami --json | jq -r .workspaceIdopenemail emails list --status failed --json | jq -r ".items[].id"

एरर stderr पर JSON की एक लाइन के रूप में जाता है, और एग्ज़िट कोड वही होता है जो किसी व्यक्ति को मिलता:

{"error":{"type":"permission_error","code":"insufficient_scope","message":"This API key does not have the domains:write scope.","hint":"The credential is missing a scope this call needs. Use a key that has it, or sign in again with openemail login.","next":null,"status":403,"requestId":"req_7Hc2kQ","param":null,"docUrl":"https://openemail.uk/docs/api/errors#insufficient_scope","exitCode":4}}

कुछ आउटपुट JSON ऑब्जेक्ट की स्ट्रीम होता है, हर लाइन में एक, ताकि पाइपलाइन हर आइटम को आते ही संभाल सके:

• —रिसोर्स सूची --all के साथ जब stdout टर्मिनल न हो, या --ndjson के साथ। --max <n> उतने आइटम के बाद रुकता है।
• —openemail temp watch --json, हर नए संदेश के लिए एक लाइन।
• —openemail mcp serve, दोनों दिशाओं में हर लाइन में एक JSON-RPC संदेश।

openemail contacts list --all > contacts.ndjsonopenemail emails list --status failed --all --max 500 | jq -r .id

CLI सिर्फ़ तब प्रॉम्प्ट करती है जब stdin और stdout दोनों टर्मिनल हों, और --json, --no-input या CI में से कोई लागू न हो। वरना:

• —कोई ज़रूरी वैल्यू न हो तो एग्ज़िट कोड 2 के साथ रुकता है और देने वाला फ़्लैग बताता है।
• —विनाशकारी कमांड Refusing to run unattended. Pass --yes to confirm. और एग्ज़िट कोड 2 के साथ रुकती है, जब तक आप --yes न दें।
• —जिस बदलाव को सत्यापन कोड चाहिए वह एग्ज़िट कोड 4 के साथ रुकता है, क्योंकि उसे कोई टाइप नहीं कर सकता। API कुंजी इस्तेमाल करें, या पहले openemail verify चलाएँ।

जॉब को सिर्फ़ ज़रूरी स्कोप वाली API कुंजी दें, उसे किसी सीक्रेट में रखें, और OPENEMAIL_API_KEY को उसे ले जाने दें। कुछ सहेजा नहीं जाता, कुछ पूछा नहीं जाता, और कोई अपडेट जाँच नहीं चलती।

- name: Tell the team  env:    OPENEMAIL_API_KEY: ${{ secrets.OPENEMAIL_API_KEY }}  run: |    npx -y @openemail/[email protected] send \      --from [email protected] \      --to [email protected] \      --subject "Deployed ${{ github.sha }}" \      --text "Build ${{ github.run_number }} is live." \      --idempotency-key "deploy-${{ github.run_id }}"

ADDRESS=$(npx -y @openemail/[email protected] temp new --ttl 15)./signup-test.sh "$ADDRESS"npx -y @openemail/[email protected] temp watch --first --json | jq -r .snippetnpx -y @openemail/[email protected] temp delete --yes

failed=$(openemail emails list --status failed --json | jq ".items | length")test "$failed" -eq 0