Për agjentët AI

openemail agents shtyp një udhëzues të shkurtër në Markdown për një agjent AI si Claude Code ose Codex, ose për një skript në CI: si të hyjë pa një njeri, të lexojë daljen, të gjejë komandat, të ndryshojë gjërat në mënyrë të sigurt dhe të shfletojë listat, çfarë të bëjë kur mungon një kod verifikimi ose një fushëveprim, dhe pesë receta për t'u kopjuar. openemail agent është e njëjta komandë.

openemail agentsopenemail agents --json | jq -r '.recipes[].commands[]'

Me --json udhëzuesi është një dokument i vetëm me schemaVersion, title, intro, sections prej { id, title, points }, exitCodes dhe recipes prej { id, title, commands }. Në vend që t'i ngjitni këto rregulla në çdo prompt, thojini agjentit një herë, në skedarin e udhëzimeve që projekti juaj i jep tashmë, të ekzekutojë openemail agents para se të përdorë CLI-në.

• —Përdorni një çelës API. Vendosni OPENEMAIL_API_KEY, ose kalojini --api-key një komande të vetme. Krijojeni te Cilësimet → Çelësat API (openemail open api-keys) vetëm me fushëveprimet që i duhen agjentit. Një çelës nuk hap kurrë shfletues dhe nuk ka nevojë kurrë për kod verifikimi.
• —Ose ripërdorni një hyrje me shfletues që një njeri e bëri një herë në këtë makinë me openemail login, dhe zgjidheni me --profile <name>. CLI i rinovon tokenët e vet vetë.
• —Pa terminal asgjë nuk pyet. Nën --json, --no-input ose CI, ose pa terminal të lidhur, një vlerë që CLI do ta kishte pyetur ndalet me kodin e daljes 2 dhe emërton flamurin që duhet kaluar.
• —Një hyrje me shfletues ka nevojë që një njeri ta miratojë, ndaj një openemail login pa mbikëqyrje ndalet me kodin e daljes 2 dhe kodin unattended para se të regjistrojë ndonjë gjë, dhe drejton te openemail login --with-token.
• —openemail whoami --json tregon hapësirën e punës, llojin e hyrjes dhe scopes e saj.

Kalojini --json çdo komande. Atëherë stdout mban saktësisht një dokument JSON, ose një objekt për rresht me --ndjson, dhe ecuria mbetet në stderr. Një dështim shtyp një rresht {"error":{...}} në stderr: degëzoni sipas kodit të daljes dhe code të tij, tregojini next një njeriu dhe mos e analizoni kurrë message, formulimi i të cilit mund të ndryshojë. Faqja Skriptet rendit çdo fushë dhe çdo kod daljeje.

--help --json shtyp ndihmën si një dokument i vetëm JSON, të ndërtuar nga i njëjti regjistër komandash me të cilin CLI analizon, ndaj përputhet gjithmonë me versionin e instaluar. Funksionon në rrënjë, në një grup ose në një komandë, dhe openemail help <command> --json shtyp të njëjtën gjë.

openemail send --help --jsonopenemail domains delete --help --json | jq '.commands[0] | {scopes, destructive}'openemail help domains --json | jq -r '.commands[0].subcommands[].command'openemail --help --json | jq -r '.commands[].command'

E gjithë pema është rreth një megabajt, pothuajse e gjitha 198 komandat e burimeve, ndaj kërkoni komandën që ju duhet, ose filtrojeni pemën me jq. Teksti i mban thonjëzat e pasme dhe nuk mbart kode ngjyrash, dhe komandat e fshehura si security përfshihen me hidden të vendosur në true.

--dry-run funksionon në çdo komandë përveç mcp serve. Leximet ekzekutohen si zakonisht, pastaj kërkesa e parë që do të ndryshonte diçka shtypet në vend që të dërgohet, dhe komanda del me kodin 0 pa bërë asgjë tjetër. Konfirmimet kapërcehen, meqë nuk dërgohet asgjë, ndaj një agjent mund të shohë çfarë do të bënte një komandë shkatërruese pa kaluar --yes.

openemail domains delete <domain-id> --dry-runopenemail send --from [email protected] --to [email protected] --subject "Hi" --text "Hello" --dry-run --json

{  "dryRun": true,  "request": {    "method": "POST",    "url": "https://api.openemail.uk/emails",    "headers": {      "accept": "application/json",      "authorization": "Bearer [redacted]",      "content-type": "application/json",      "idempotency-key": "58e6fb61-ad2e-401e-b141-7a0546c7c749",      "user-agent": "openemail-cli/0.0.1 openemail-sdk/0.0.5"    },    "body": {      "from": "[email protected]",      "to": [        "[email protected]"      ],      "subject": "Hi",      "text": "Hello"    },    "raw": null  }}

• —Një ndryshim është çdo kërkesë përveç GET dhe HEAD, një thirrje mjeti MCP, dhe kërkesat e hyrjes dhe daljes së login dhe logout. Rinovimi i tokenëve dhe docs ask ekzekutohen gjithsesi.
• —Plani tregon metodën, URL-në e plotë, kokat me vlerën e Authorization të shkurtuar në Bearer [redacted], dhe trupin JSON me fushat sekrete, si një çelës Resend, të fshehura. Një ngarkim tregon vetëm madhësinë dhe llojin e përmbajtjes.
• —Një ndryshim që mbetet në këtë makinë, si profile use, login --with-token ose harrimi i një çelësi API të ruajtur, shtyp {"dryRun":true,"local":{"action","profile"}} dhe nuk ruan asgjë.
• —Një komandë që shtyp atë që lexoi para ndryshimit të saj të parë e tregon atë së pari: read shtyp bisedën, pastaj kërkesën që do ta shënonte si të lexuar. Kaloni --no-mark-read për ta lënë jashtë të dytën.
• —mcp serve e refuzon --dry-run me kodin e daljes 2, sepse klienti i tij vendos çfarë të dërgojë. Në vend të kësaj, shihni paraprakisht një thirrje mjeti me openemail mcp call <tool> --dry-run.

Çdo komandë i di fushëveprimet API që i duhen gjithmonë, dhe ndihma e saj i rendit. Kur një hyrjeje të ruajtur i mungon një prej tyre, komanda i kërkon API-së një herë listën aktuale, ndaj aksesi i dhënë në faqen e internetit pas hyrjes vlen menjëherë. Nëse fushëveprimi mungon ende, ajo ndalet me kodin e daljes 4 dhe kodin insufficient_scope para se të pyesë ndonjë gjë ose të dërgojë një kërkesë:

{"error":{"type":"cli_error","code":"insufficient_scope","message":"This sign-in does not have the emails:send permission, which openemail send needs.","hint":null,"next":"Give this app more access in Account settings, Connected apps (openemail open apps, then Edit access), or run openemail login --force and choose more access.","status":null,"requestId":null,"param":null,"docUrl":null,"exitCode":4}}

• —Për një hyrje me shfletues, next thotë t'i jepni aplikacionit më shumë akses te Llogaria → Rreshti i komandave (openemail open cli, pastaj Redakto aksesin), ose të ekzekutoni openemail login --force dhe të zgjidhni më shumë akses. Një hyrjeje me shfletues nuk i jepet kurrë keys:write ose keys:manage, ndaj për to drejton te një çelës API.
• —Për një çelës API, next thotë të përdorni një çelës që e ka fushëveprimin.
• —Një çelës nga --api-key ose OPENEMAIL_API_KEY nuk kontrollohet paraprakisht, dhe vendos API. Kur API refuzon një thirrje për një fushëveprim që mungon, gabimi mbart të njëjtin next.

Një çelës API nuk ka nevojë kurrë për kod verifikimi. Një hyrje me shfletues ka nevojë për një para një ndryshimi të ndjeshëm, si shtimi i një webhook-u, krijimi i një rregulli, ndryshimi i një anëtari ose heqja e një domeni, dhe një agjent nuk mund ta shkruajë. Ndaj, para se të ekzekutohet agjenti, një njeri ose ekzekuton openemail verify në një terminal me të njëjtin profil, ose zgjedh Lejo ndryshimet për 60 minuta për atë hyrje te Llogaria → Rreshti i komandave. Secila mbulon 60 minutat e ardhshme.

openemail verifyopenemail verify --status --json

verify --status --json i tregon agjentit nëse profili është i verifikuar, në elevated, dhe deri kur, në elevatedUntil. Pa verifikim ndryshimi ndalet me kodin e daljes 4 dhe kodin step_up_required, dhe nuk ndryshohet asgjë:

{"error":{"type":"cli_error","code":"step_up_required","message":"This action needs a verification code, and there is no interactive terminal to ask for one.","hint":null,"next":"Run openemail verify in an interactive terminal first, then run this again within 60 minutes. An API key never needs a code.","status":403,"requestId":"req_9Qm4tV","param":null,"docUrl":"https://openemail.uk/docs/api/errors#step_up_required","exitCode":4}}

Një agjent që flet MCP mund të përdorë në vend të kësaj serverin MCP të OpenEmail. openemail mcp config --client claude-code, ose codex, cursor dhe klientët e tjerë që rendit, shtyp konfigurimin, dhe openemail mcp serve është një urë lokale që ripërdor hyrjen me shfletues të kësaj CLI. Çelësat API nuk mund të arrijnë serverin MCP. Faqja AI dhe MCP ka hollësitë.