اسکریپت‌نویسی

با --json، stdout فقط JSON با تورفتگی دو فاصله دارد، یادداشت‌ها و پیشرفت روی stderr می‌مانند و هیچ چیز پرسیده نمی‌شود. یک فهرست { items, hasMore, nextCursor } را چاپ می‌کند، یک شیء API همان‌طور که API برگردانده چاپ می‌شود و یک فرمان دست‌نوشته شیئی را چاپ می‌کند که راهنمایش توصیف کرده است.

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

خطا به‌صورت یک سطر JSON به stderr می‌رود و کد خروج همان است که یک انسان می‌گرفت:

{"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