CLI
Komandat
Si lexohet një komandë, flamujt globalë, çdo komandë e shkruar me dorë dhe çdo hapësirë emrash burimesh.
Si lexohet një komandë
openemail <command> [subcommand] [arguments] [flags]- Flamujt vendosen kudo pas komandës, para ose pas argumenteve. Flamujt globalë si
--profiledhe--jsonmund të vijnë edhe para saj, dhe çdo flamur tjetër i vendosur aty ndalet me një këshillë për ta zhvendosur pas emrit të komandës. - Një vlerë e ndjek flamurin e vet pas një hapësire ose një shenje barazimi, prandaj
--limit 50dhe--limit=50janë e njëjta gjë. Edhe flamujt e shkurtër marrin vlera, si te-n 50. - Një vlerë që nis me vizë ka nevojë për shenjën e barazimit, si te
--subject=-draft-, sepse pas një hapësire lexohet si flamuri i radhës dhe për të parin raportohet se i mungon vlera. Numrat negativë funksionojnë në të dyja mënyrat. Një vlerë bosh është gabim përdorimi dhe jo një vlerë e paracaktuar e heshtur. - Një ndërprerës ndizet me
--flagdhe fiket me--no-flag, dhe funksionojnë edhe--flag=truedhe--flag=false. - Një listë ndahet me presje ose përsëritet:
--to [email protected],[email protected], ose--tody herë. - Gjithçka pas
--është argument dhe kurrë flamur, dhe kështu kalon një kërkim për-from:ada. - Një komandë ose flamur i panjohur ndalet me kodin e daljes
2dhe sugjeron përputhjen më të afërt.
Flamujt globalë
| Flamuri | Çfarë bën |
|---|---|
| -h, --help | Ndihma për komandën ose grupin |
| -v, --version | Shtyp versionin e CLI-së |
| --json | Vetëm JSON në stdout, gabimet si JSON në stderr, dhe asnjë kërkesë |
| -y, --yes | Konfirmo veprimet shkatërruese pa pyetur. Nuk e kapërcen kurrë një kod verifikimi |
| --profile <name> | Përdor këtë profil të ruajtur, si OPENEMAIL_PROFILE |
| --api-key <key> | Përdor këtë çelës API vetëm për këtë komandë, duke shpërfillur profilet |
| --base-url <url> | Origjina e API-t për një çelës API ose një komandë që nuk dërgon kredencial, si OPENEMAIL_BASE_URL. Një hyrje e ruajtur përdor gjithmonë të vetën |
| --no-input | Mos pyet kurrë. Një vlerë që mungon ndalet me kodin e daljes 2 |
| --no-color | Pa ngjyra, si NO_COLOR dhe FORCE_COLOR=0 |
| --debug | Shtyp ID-të e kërkesave, kërkesën e dështuar dhe gjurmët e stivës |
Komandat e shkruara me dorë
Këto janë shkruar për njerëz: pyesin për atë që mungon, formatojnë atë që shtypin dhe bashkojnë disa thirrje API kur kjo ndihmon.
| Komanda | Çfarë bën |
|---|---|
| login | Hyni me shfletuesin, ose ruani një çelës API |
| whoami | Me kë keni hyrë, me hapësirën e punës, fushëveprimet dhe skadimin |
| status | Ajo që tregon whoami, plus adresat tuaja të dërgimit dhe gjendja e çdo domeni |
| verify | Futni tani një kod verifikimi, që komandat e ndjeshme të punojnë për 60 minuta |
| logout | Dilni dhe harroni një profil |
| profile list, use, current, remove | Listoni, ndërroni dhe hiqni hyrjet e ruajtura |
| send | Dërgoni, planifikoni, ose përktheni dhe dërgoni një email |
| inbox [folder] | Listoni bisedat në një dosje |
| search <query> | Kërkoni postën me sintaksën që përdor aplikacioni |
| read <thread-id> | Lexoni një bisedë, mesazh pas mesazhi |
| reply <thread-id> | Përgjigjuni mesazhit të fundit të një bisede |
| archive, unarchive, trash, star, unstar | Renditni një ose më shumë biseda |
| mark read, mark unread | Shënoni bisedat si të lexuara ose të palexuara |
| snooze, unsnooze | Fshihni bisedat deri më vonë, ose kthejini tani |
| label add, label remove | Vendosni etiketa në biseda, ose hiqini |
| temp new, list, read, watch, delete | Kuti të përkohshme, pa hyrje |
| ai translate, languages, compose, summarize | Përktheni, shkruani dhe përmblidhni postën me AI |
| mcp config, tools, call, serve | Lidhni klientë AI, ose thirrni vetë mjetet MCP |
| docs ask, open, read | Pyesni, hapni dhe lexoni këtë dokumentacion |
| open [page] | Hapni një faqe të aplikacionit web |
| api <method> <path> | Thirrni çdo endpoint REST me hyrjen tuaj |
| update | Kontrolloni npm për një publikim më të ri |
| completion <shell> | Shtypni një skript plotësimi për bash, zsh ose fish |
| version | Shtypni versionet e CLI-së, SDK-së dhe mjedisit të ekzekutimit |
| help [command] | Tregoni ndihmën e çdo komande |
Komandat e burimeve
Çdo metodë e SDK-së është edhe komandë: openemail <namespace> <verb>. Hapësira e emrave është hapësira e emrave e SDK-së në kebab-case, dhe folja është emri i metodës në kebab-case, prandaj keys.listRequests bëhet openemail keys list-requests. Bashkë mbulojnë gjithë REST API-n.
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- Një ID që merr metoda është argument, si te
openemail domains get <id>. Çdo fushë e trupit të kërkesës është një flamur me emrin e saj në kebab-case:replyTobëhet--reply-to, dhecolor.backgroundColorbëhet--color-background-color. - Tri fusha, flamuri i të cilave do të përplasej me një flamur global, janë riemërtuar:
--template-version,--label-colordhe--resend-key. --datamerr gjithë trupin si JSON, brenda rreshtit, nga një skedar me@path, ose nga stdin me-, dhe çdo flamur që jepni gjithashtu e mbishkruan çelësin e vet. Një flamur që merr një objekt e lexon JSON-in në të njëjtën mënyrë.- Numrat dhe ndërprerësit lexohen si të tillë, dhe listat ndahen me presje ose përsëriten.
- Një vlerë e detyrueshme që mungon kërkohet në terminal, dhe kudo tjetër është gabim përdorimi (kodi i daljes
2). - Një folje liste lexon një faqe.
--limitcakton madhësinë e saj dhe--cursorvazhdon nga kursori që shtypi.--alllexon çdo faqe dhe i transmeton elementet,--max <n>ndalet pas aq sa jepni, dhe--ndjsonshtyp një objekt JSON për rresht. - Çdo gjë shkatërruese, si fshirja, revokimi, rrotullimi, anulimi ose zbrazja, ju kërkon konfirmim, përveç nëse jepni
--yes. - Një shkarkim shkruhet në skedarin e
--out, dhe në stdout vetëm kur stdout nuk është terminal.
openemail <namespace> <verb> --help tregon çdo argument dhe flamur me llojin e tij, fushëveprimet që i duhen thirrjes, metodën dhe shtegun, çfarë kthen, dhe shënimet nga referenca e API-t.
Çdo hapësirë emrash
Kolona Gjithashtu liston emrat e tjerë ndaj të cilëve përgjigjet një hapësirë emrash.
| Hapësira e emrave | Gjithashtu | Foljet |
|---|---|---|
| me | get, ping, rotate | |
| keys | key | list, get, create, update, delete, rotate, revoke, list-requests, list-activity, list-workspace-requests, list-workspace-activity |
| addresses | address | list |
| languages | language | list |
| emails | email | send, send-batch, translate, list, get, list-events, get-tracking, cancel, reschedule |
| templates | template | list, get, create, update, duplicate, replace-content, delete, list-versions, get-version, publish, restore-version, delete-version, list-starters, get-starter, list-fonts, render, preview, get-analytics, list-sends, send |
| tracking | list, get-stats, get, list-opens, list-clicks | |
| threads | thread | list, get, update, trash, snooze, unsnooze, list-attachments |
| drafts | draft | list, get, create, update, delete |
| labels | list, list-colors, get, create, update, delete | |
| contacts | contact | list, get, create, update, delete, set-audiences, list-people, save, delete-many, set-photo, remove-photo, block, unblock, list-threads, activity |
| audiences | audience | list, growth, get, create, update, delete, empty, list-contacts, add-contact, remove-contact, add-contacts, remove-contacts, import-contacts |
| broadcasts | broadcast | preview, send, list, get, stats, list-recipients, get-recipient, cancel |
| domains | domain | list, get, create, verify, update, delete, list-addresses, create-address, get-address, update-address, delete-address |
| rules | rule | list, get, create, update, delete, reorder, test, list-runs |
| webhooks | webhook | list, get, create, update, delete, rotate-secret, test, list-deliveries, get-delivery, replay-delivery, list-workspace-deliveries, list-activity, list-workspace-activity |
| imports | import | list, get, create, upload-state, upload-chunk, start, cancel, list-failures, delete-upload, import-files |
| provider-imports | provider-import, providerImports | inspect, create, list, get, cancel |
| calendar | list-events, get-event, get-event-ics | |
| settings | setting | get, update |
| roles | role | list, get, create, update, delete, list-permissions |
| members | member | list, get, add, update, remove, grant-address, revoke-address, list-invitations, revoke-invitation, resend-invitation |
| suppressions | suppression | list, get, add, remove |
| files | file | list, get, stats, download, list-links, create-link, revoke-link, upload, delete, delete-many |
| temp-mail | tempMail | list-domains, create, get, extend, delete, list-messages, get-message, delete-message, list-attachments |
Pseudonimet
| Pseudonimi | Për |
|---|---|
| ls | list |
| show, view | get |
| new, add | create |
| edit | update |
| rm, del, remove | delete |
| openemail ls | openemail inbox |
| openemail show | openemail read |
Te members dhe suppressions, foljet e të cilave janë add dhe remove, new dhe create çojnë te add, dhe rm, del dhe delete çojnë te remove. Disa nënkomanda të shkruara me dorë kanë pseudonimet e tyre, që i liston ndihma e tyre.
Çdo thirrje REST
openemail api <method> <path> dërgon një kërkesë te REST API përmes të njëjtit transport si çdo komandë tjetër, ndaj vlejnë profili ose çelësi juaj, rinovimi i tokenit dhe kodet e verifikimit. Një shteg më vete është një GET. Një përgjigje JSON shtypet e formatuar, dhe një kërkesë e dështuar shtyp gabimin e API-t dhe del me kodin përkatës.
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,--datamerr trupin si JSON në rresht, nga një skedar me@path, ose nga stdin me-.-q,--querydhe-H,--headermarrinkey=valuedhe mund të përsëriten, dhe-o,--oute ruan përgjigjen në një skedar ashtu siç erdhi.- Shtegu është relativ ndaj origjinës së API-t. Një URL e plotë, një shteg që do të dilte nga origjina dhe një kokë
Authorizationrefuzohen me kodin e daljes2para se të dërgohet diçka, sepse kredencialin e vendos vetë CLI.
Ndihma
openemail --helpopenemail help sendopenemail domains --helpopenemail domains create --helpopenemail --help liston çdo komandë sipas qëllimit të saj. Një grup liston nënkomandat e veta me shembuj, dhe një komandë tregon gjithçka që merr. openemail docs open cli i hap këto faqe.
