Dërgimi dhe gjurmimi i emailit

Hapësira e emrave emails është API-ja e dërgimit në formë komandash, nga një për çdo metodë të openemail.emails në SDK. Secila thërret një endpoint dhe shtyp atë që kthen. Hapësira e emrave tracking lexon hapjet dhe klikimet te posta që dërguat. openemail email funksionon në vend të openemail emails.

Çdo komandë këtu ka nevojë për një hyrje, me shfletues ose me një çelës API, dhe për një nga dy fushëveprime: emails:send për të dërguar, përkthyer, anuluar dhe riplanifikuar, dhe emails:read për gjithçka që vetëm lexon.

openemail send është komanda e shkruar me dorë te faqja Posta, dhe dërgon përmes emails send. Është bërë për një person në terminal: zgjedh adresën e dërgimit kur e lini jashtë --from, lexon trupin nga një skedar, stdin ose redaktori juaj, bashkëngjit skedarë sipas shtegut, dhe tregon një përmbledhje për konfirmim para se të niset ndonjë gjë. openemail emails send e merr trupin e kërkesës si flamuj, nga një për çdo fushë, dhe nuk pyet asgjë, gjë që i përshtatet një skripti që e di saktësisht çfarë dërgon.

Vetëm emails send ka --tracking për të fikur hapjet ose klikimet për një dërgim, --signature, --headers për header-a të personalizuar, --attachment-delivery për të zgjedhur mes bashkëngjitjes së skedarëve dhe lidhjes me to, dhe --data për gjithë trupin si JSON, në rresht, nga një skedar me @path ose nga stdin me -.

send, send-batch, translate, cancel dhe reschedule kërkojnë emails:send. list, get, list-events dhe get-tracking kërkojnë emails:read. Një id emaili është msg_ e ndjekur nga 24 karaktere hex, siç e kthen një dërgim.

Të pesat kërkojnë emails:read. tracking get, list-opens dhe list-clicks pranojnë cilëndo nga dy id-të që ka një mesazh: id-në msg_ që ktheu dërgimi i tij, ose id-në e gjurmimit tmsg_ që mbartin tracking list dhe payload-et e webhook-ëve.

tracking list dhe get-stats mbulojnë çdo mesazh të gjurmuar që dërgoi kutia postare, përfshirë postën e shkruar në aplikacionin web dhe postën e dërguar nga mjetet MCP ose asistenti, ndërsa emails list mban regjistrat e dërgimeve që krijoi API. Një raport pa regjistër dërgimi e ka sendId të caktuar në null.

Dërgoni nga një skript me një çelës idempotence tuajin. Ekzekutimi sërish me të njëjtin --idempotency-key shtyp emailin e parë me replayed: true në vend që të dërgojë një të dytë.

openemail emails send \  --from 'Acme Billing <[email protected]>' \  --to [email protected] \  --subject 'Your September invoice' \  --html '<p>The invoice is attached. Tell me if anything on it looks wrong.</p>' \  --attachments '[{"fileId":"file_6bb640f5b99e47deb758f1f5"}]' \  --tracking '{"opens":false}' \  --idempotency-key invoice:inv_2026_09_4192 \  --json | jq -r '.id + " " + .status'

Lëreni një person ta lexojë përkthimin para se të niset. Dërgojeni tekstin e miratuar si --subject dhe --html të thjeshtë, pa --translate, përndryshe përkthehet për herë të dytë. html i përkthyer e mban tashmë origjinalin tuaj poshtë tij, përveç nëse jepni --no-include-original.

openemail emails translate --to de \  --subject 'Your September invoice' \  --html "$(cat invoice.html)" \  --json > preview.jsonjq -r .html preview.jsonopenemail emails send --from [email protected] --to [email protected] \  --subject "$(jq -r .subject preview.json)" \  --html "$(jq -r .html preview.json)"

Dërgoni një batch nga një skedar. Komanda del me kodin 0 sa herë që batch-i u përpunua, edhe kur disa elemente dështuan, ndaj lexoni failed dhe status e çdo elementi. Ekzekutimi sërish me të njëjtin çelës riluan elementet që u nisën dhe dërgon vetëm të tjerat, për sa kohë array-i ruan rendin e vet.

[  { "from": "[email protected]", "to": "[email protected]", "subject": "Receipt 4192", "text": "Thanks for your order." },  { "from": "[email protected]", "to": "[email protected]", "subject": "Receipt 4193", "text": "Thanks for your order." }]

openemail emails send-batch receipts.json --idempotency-key receipts:2026-09-27 --json > result.jsonjq '{ sent, failed }' result.jsonjq -r '.items[] | select(.status == "error") | "\(.index) \(.error.code)"' result.json

Planifikoni një email, zhvendoseni dhe anulojeni. --yes i përgjigjet konfirmimit që kërkon cancel, gjë që një skript nuk mund ta bëjë.

ID=$(openemail send --from [email protected] --to [email protected] --subject "Standup notes" \  --body-file notes.md --at 2026-10-01T09:00:00Z --json | jq -r .id)openemail emails reschedule "$ID" 2026-10-01T13:00:00Zopenemail emails get "$ID" --json | jq -r '.status + " " + .scheduledAt'openemail emails cancel "$ID" --yes

Gjeni dërgimet që dështuan dhe lexoni çfarë ndodhi me njërin. Kur dalja dërgohet në pipe pa --json, --all shtyp një objekt JSON për rresht.

openemail emails list --status failed,partial --from [email protected] --all | jq -r .idopenemail emails get msg_3f9a1c07d2b84e6a9c5b1f20openemail emails list-events msg_3f9a1c07d2b84e6a9c5b1f20 --all --json | jq -r '.items[] | .createdAt + " " + .type'

Lexoni një javë angazhimi në ditë që ndahen në mesnatë UTC+2, listoni atë që nuk e hapi askush, dhe numëroni klikimet në çdo lidhje të një mesazhi.

openemail tracking get-stats --days 7 --offset-minutes 120 --json | jq '{ tracked, openRate, clickRate }'openemail tracking list --no-opened --days 7 --all | jq -r .subjectopenemail tracking list-clicks msg_3f9a1c07d2b84e6a9c5b1f20 --all | jq -r .url | sort | uniq -c

• —Një hyrje me shfletues kërkon fushëveprime në faqen e miratimit, dhe openemail login --scopes emails:send,emails:read i parazgjedh të dyja. Një komandë së cilës i mungon fushëveprimi ndalet me kodin e daljes 4 dhe insufficient_scope, dhe e emërton fushëveprimin.
• —send --attach me më shumë se 5 MB skedarë i ngarkon ata fillimisht te Skedarët, gjë që kërkon edhe files:write.
• —Asnjë nga këto komanda nuk kërkon kod verifikimi, ndaj një hyrje me shfletues i ekzekuton ashtu si një çelës API.
• —emails cancel pyet para se të anulojë, dhe --yes përgjigjet për ju. Pa mbikëqyrje dhe pa --yes, ndalet me Refusing to run unattended. Pass --yes to confirm. dhe kodin e daljes 2.
• —emails send, send-batch dhe reschedule nuk pyesin kurrë. send tregon një përmbledhje dhe pyet vetëm në terminal, dhe --yes e kapërcen edhe këtë.
• —--dry-run shtyp kërkesën që do të dërgonte një komandë, nuk dërgon asgjë dhe del me kodin 0. Te emails translate kjo nuk shpenzon asnjë veprim AI, dhe te emails cancel nuk pyet asgjë.

emails list, emails list-events, tracking list, list-opens dhe list-clicks lexojnë një faqe. --limit cakton madhësinë e saj, nga 1 deri në 100 me 25 si parazgjedhje për dy listat emails, dhe nga 1 deri në 200 me 50 si parazgjedhje për tri listat tracking. --cursor vazhdon nga kursori që shtypi një faqe.

• —--all lexon çdo faqe dhe i transmeton elementet: një tabelë në terminal, dhe një objekt JSON për rresht kur dalja dërgohet në pipe ose me --ndjson.
• —--max <n> ndalet pas aq elementeve dhe nënkupton --all.
• —--json shtyp një dokument të vetëm { items, hasMore, nextCursor }, përfshirë me --all.
• —Faqet ndahen me kursor, jo me zhvendosje, ndaj posta e dërguar ndërsa shfletoni faqet nuk e zhvendos dhe nuk e përsërit kurrë një rresht.

• —Çdo ekzekutim krijon çelësin e vet të idempotencës, i cili mbulon riprovimet brenda atij ekzekutimi. Nëse e ekzekutoni një dërgim dy herë, ai dërgon dy herë, përveç nëse të dy ekzekutimet japin të njëjtin --idempotency-key. I njëjti çelës me një trup tjetër refuzohet me idempotency_key_reuse dhe kodin e daljes 7.
• —Vetëm posta queued dhe scheduled mund të anulohet ose të zhvendoset. Një dërgim i menjëhershëm pa dritare zhbërjeje niset brenda kërkesës, ndaj kur ta keni id-në e tij zakonisht është tepër vonë, dhe thirrja përfundon me email_not_cancellable dhe kodin e daljes 6.
• —Një email i anuluar mbetet i anuluar. Riplanifikimi ndryshon vetëm kohën, e numëruar nga çasti kur serveri merr kërkesën në rastin e një kohëzgjatjeje, ndaj për të ndryshuar tekstin, anulojeni dhe dërgojeni sërish.
• —Një përkthim që nuk mund të prodhohet e refuzon gjithë dërgimin, dhe asgjë nuk niset e papërkthyer. Një batch i përkthyer mban të shumtën 10 mesazhe që mbartin translate.
• —Një kuotë dërgimi e shteruar e ndal një dërgim me send_quota_exceeded deri në ditën e parë të muajit, dhe një kuotë AI e shteruar e ndal një përkthim me ai_quota_exceeded deri në mesnatë UTC, të dyja me kodin e daljes 8.
• —Posta e dërguar me një çelës oe_test_ nuk dorëzohet kurrë. Lexohet si sent, me transport të caktuar në test, dhe nuk gjurmohet kurrë.
• —emails get-tracking dhe tracking get përgjigjen me 404, kodi i daljes 5, për një mesazh që nuk mbarti as piksel as lidhje të rishkruar, sepse i pagjurmuar nuk është njësoj si i pahapur. Gjurmimi ndjek cilësimin me të cilin u dërgua mesazhi, ndaj ndezja e tij më vonë nuk e arrin postën e mëparshme.
• —Çdo numër është një minimum. Një lexues klienti i postës i të cilit bllokon imazhet nuk numërohet kurrë si hapje, dhe një klikim është provë më e fortë leximi se një hapje.
• —list-opens dhe list-clicks përgjigjen me 404 për një id msg_ pa asgjë të gjurmuar, por e pranojnë një id tmsg_ ashtu siç jepet, ndaj një id e panjohur kthehet si listë bosh.
• —Një çelës i kufizuar në disa adresa sheh vetëm postën e dërguar nga ato adresa, dhe një çelës që mban një domen të tërë mbulon çdo adresë në të.

Kjo faqe emërton flamujt që kanë më shumë rëndësi. openemail <command> --help liston çdo argument dhe flamur që merr një komandë, me llojin e tij, fushëveprimin që i duhet, metodën dhe shtegun, çfarë kthen dhe shënimet nga referenca e API-t. Shtoni --json për të njëjtën ndihmë si një dokument i vetëm JSON.

openemail emails --helpopenemail emails send --helpopenemail tracking list-opens --help --json