Kontaktet, audiencat dhe transmetimet

Katër hapësira emrash mbulojnë njerëzit të cilëve u shkruani. Kontaktet janë libri i adresave i hapësirës së punës, audiencat janë lista kontaktesh me emër, një transmetim dërgon një mesazh te të gjithë në disa audienca, dhe lista e ndalimeve mban adresat te të cilat hapësira e punës nuk do të dërgojë. Çdo komandë thërret një metodë të SDK-së, ndaj faqet e SDK-së i përshkruajnë të njëjtat thirrje më në thellësi.

• —Një kontakt nuk ka id. Adresa e tij është çelësi që merr çdo komandë contacts, e shkurtuar nga hapësirat dhe me shkronja të vogla, ndaj [email protected] dhe [email protected] janë një kontakt i vetëm. Një audiencë ka një id aud_, një transmetim një id brd_, dhe një ndalim id-në që shtyp suppressions list.
• —Çdo kontakt ndodhet në audiencën e parazgjedhur për sa kohë ekziston. Ajo audiencë nuk mund të fshihet, zbrazet ose hollohet, dhe builtin në të është default.
• —Libri i adresave i përket hapësirës së punës, ndaj çdo anëtar dhe çdo çelës lexon dhe shkruan të njëjtin libër.
• —Çdo hapësirë emrash i përgjigjet edhe njëjësit të vet, si te openemail contact get, dhe pseudonimet e zakonshme funksionojnë: ls, show, new, edit dhe rm. Te suppressions, foljet e së cilës janë add dhe remove, new çon te add dhe rm te remove.

Libri i adresave i hapësirës së punës: njerëzit të cilëve u ka shkruar një anëtar nga kompozuesi i aplikacionit, plus kushdo i ruajtur me dorë. Posta që mbërrin nuk shton askënd, as një dërgim përmes API-t ose CLI-së.

Lista kontaktesh me emër, deri në 100 në një hapësirë pune. Një adresë duhet të jetë kontakt para se të hyjë në një të tillë, përveçse përmes import-contacts, që i ruan adresat e reja ndërsa ecën.

Një mesazh për të gjithë në deri në 10 audienca, i dërguar si kopje më vete për çdo person, me fushat e bashkimit të plotësuara dhe një lidhje çregjistrimi. Çdo kopje është një email i zakonshëm me id-në e vet msg_, ngjarjet dhe webhook-ët e vet.

Adresat te të cilat kjo hapësirë pune nuk do të dërgojë: kthimet e forta dhe ankesat, të regjistruara ndërsa ndodhin, dhe çdo adresë që shtoni me dorë. Një dërgim te njëra prej tyre refuzohet për atë marrës para se të niset ndonjë gjë.

Shumica e komandave kanë nevojë për fushëveprimin e leximit ose të shkrimit të hapësirës së tyre të emrave. Disa kanë nevojë për një tjetër, sepse lexojnë ose ndryshojnë diçka tjetër:

• —Një çelës i kufizuar në adresa ose domene të caktuara lexon dhe shkruan të njëjtin libër adresash si çdo çelës tjetër. Sheh vetëm transmetimet e dërguara nga një adresë ose domen që mban, merr vetëm kontaktet e ruajtura nga list-people, dhe refuzohet me 422 capability_unsupported nga contacts list-threads, activity, block dhe unblock, si edhe nga suppressions add dhe remove.
• —Një hyrje me shfletues nga një anëtar që arrin vetëm disa adresa refuzohet me 422 capability_unsupported në çdo komandë contacts, audiences dhe broadcasts. suppressions add refuzon një hyrje me shfletues nga kushdo përveç pronarit të hapësirës së punës.

Ndërtoni një audiencë nga një skedar, pastaj numëroni kë do të arrinte një transmetim te ajo. import-contacts ruan adresat që nuk janë ende kontakte, dhe ekzekutimi sërish nuk krijon dhe nuk shton asgjë dy herë.

[  { "email": "[email protected]", "name": "Ada Lovelace" },  { "email": "[email protected]", "name": "Grace Hopper" },  { "email": "[email protected]" }]

AUDIENCE=$(openemail audiences create --name 'Product updates' --json | jq -r .id)openemail audiences import-contacts "$AUDIENCE" --contacts @contacts.jsonopenemail broadcasts preview --audience-ids "$AUDIENCE"

Kontrolloni një transmetim me --dry-run, që shtyp kërkesën dhe nuk dërgon asgjë, pastaj dërgojeni. Transmetimi krijohet menjëherë dhe dërgohet në sfond, ndaj kontrolloni vazhdimisht me get për ta ndjekur. Ky trup nuk e vendos {{unsubscribeUrl}}, ndaj çdo kopje merr një fund faqeje çregjistrimi me një rresht.

{  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],  "from": "Acme <[email protected]>",  "subject": "{{firstName|Hello}}, the September release is out",  "html": "<p>Hi {{firstName|there}},</p><p>Here is what changed this month.</p>",  "scheduledAt": "2026-10-01T09:00:00Z"}

openemail broadcasts send --data @broadcast.json --dry-runBROADCAST=$(openemail broadcasts send --data @broadcast.json --yes --json | jq -r .id)openemail broadcasts get "$BROADCAST"openemail broadcasts stats "$BROADCAST" --grain day

Shihni kë nuk arriti një transmetim. --ndjson shtyp një marrës për rresht, dhe --all --json një dokument me çdo faqe.

openemail broadcasts list-recipients brd_5a8c1e3f7b2d94a06c8e1f3b --filter bounced --ndjson | jq -r .emailopenemail broadcasts list-recipients brd_5a8c1e3f7b2d94a06c8e1f3b --filter not_opened --all --json | jq ".items | length"openemail suppressions list --reason bounce --all --max 50

Kopjoni anëtarët e regjistruar të një audience në një tjetër. jq e kthen rrjedhën në trupin që merr add-contacts, dhe --data - e lexon nga stdin. --max 200 e mban te 200 adresat që pranon një thirrje.

openemail audiences list-contacts aud_9f2c4b7e1a0d63d84c5f2e7b --statuses subscribed --max 200 --ndjson \  | jq -s '{ emails: map(.email) }' \  | openemail audiences add-contacts aud_1c4e7a9b2d0f36e85a7c1b4d --data -

Fshini çdo kontakt që kompozuesi regjistroi në një domen. delete-many merr deri në 200 adresa për thirrje, ndaj xargs -n 200 ndan një listë më të gjatë. Kontrolloni fillimisht grupet me --dry-run, sepse nuk ka zhbërje.

openemail contacts list --source auto --all --ndjson \  | jq -r 'select(.email | endswith("@old-vendor.example")) | .email' > leaving.txtxargs -n 200 openemail contacts delete-many --dry-run < leaving.txtxargs -n 200 openemail contacts delete-many --yes < leaving.txt

Ndaloni dërgimin te një adresë, lejojeni sërish një tjetër, dhe bllokoni një dërgues. removable tregon cilat rreshta do të pranojë suppressions remove.

openemail suppressions add --email [email protected]openemail suppressions list --q [email protected] --json | jq -r '.items[] | select(.removable) | .id'openemail suppressions remove 7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e --yesopenemail contacts block [email protected]

Këto komanda kërkojnë konfirmim në terminal para se të ekzekutohen:

• —--yes konfirmon për ju. Pa mbikëqyrje, me --json ose --no-input, në CI ose pa terminal, një komandë që do të pyeste ndalet me Refusing to run unattended. Pass --yes to confirm. dhe kodin e daljes 2.
• —--dry-run shtyp kërkesën që do të dërgonte komanda dhe del me kodin 0, pa pyetur dhe pa ndryshuar asgjë.
• —Me një hyrje me shfletues, audiences delete kërkon fillimisht një kod verifikimi, si aplikacioni web. --yes nuk e kapërcen kurrë, dhe pa mbikëqyrje komanda ndalet me kodin e daljes 4. Ekzekutoni më parë openemail verify, ose përdorni një çelës API, të cilit nuk i kërkohet kurrë.
• —audiences empty nuk kërkon kurrë kod verifikimi, ndaj kontrolloni id-në para se të jepni --yes.

Çdo komandë që liston lexon një faqe. Kur mbeten të tjera, jepini --cursor kursorin që shtypi, me të njëjtët filtra, ose lexojini të gjitha:

• —--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.
• —Një kursor i keqformuar ose i vjetëruar jep 400 invalid_cursor. Filloni sërish pa të.

• —contacts create e refuzon një adresë që është tashmë në libër me 409 contact_exists, ndaj një riprovim nuk e mbishkruan kurrë një emër që dikush e ka redaktuar. contacts save nuk refuzon kurrë: e ruan, e mban ose e rikthen adresën, cilado qoftë gjendja e saj.
• —contacts delete pranon edhe një adresë që është parë vetëm në postë, gjë që e heq atë person nga list-people. Posta mbetet. Nuk ka zhbërje: ruajtja sërish e adresës nis një kontakt pa emër, pa shënime dhe pa asnjë audiencë përveç asaj të parazgjedhur.
• —Adresa është identiteti i një kontakti, ndaj contacts update nuk mund ta ndryshojë. Zhvendosja e një kontakti është një delete dhe një create.
• —contacts set-photo e lexon imazhin nga një skedar, ose nga stdin me -. Jepni --content-type, si image/jpeg: pa të imazhi mund të shkojë si application/octet-stream, të cilin serveri e refuzon me 422 invalid_image.
• —broadcasts send --scheduled-at pranon një kohë ISO 8601 si 2026-10-01T09:00:00Z, ose një kohëzgjatje ISO 8601 si PT2H ose P1D, deri në 365 ditë përpara. Vonesat e shkurtra që pranon send --at, si 2h, refuzohen këtu.
• —Fushat e bashkimit funksionojnë te --subject, --html dhe --text: {{firstName}}, {{lastName}}, {{name}}, {{email}} dhe {{unsubscribeUrl}}, secila me një vlerë rezervë pas një vije vertikale, si te {{firstName|there}}. Një trup që nuk e vendos {{unsubscribeUrl}} merr një fund faqeje çregjistrimi me një rresht. Një shabllon dërgohet ashtu siç është, ndaj vendoseni lidhjen në shabllon.
• —Një transmetim kontrollohet kundrejt dërgimeve mujore të planit para se të shkruhet ndonjë gjë, dhe çdo kopje numërohet si një dërgim. Një transmetim që kuota nuk e mbulon refuzohet me 429 send_quota_exceeded, dhe nuk lihet asgjë pas.
• —Jepini broadcasts send --idempotency-key tuajin kur një skript mund ta ekzekutojë sërish hapin. I njëjti çelës përgjigjet me transmetimin që krijoi në vend që të dërgojë një të ri.
• —Një kontakt që çregjistrohet nga një transmetim mbetet në audiencë me unsubscribedAt të caktuar, dhe transmetimet e mëvonshme te ajo audiencë e anashkalojnë. audiences list-contacts --statuses unsubscribed i liston.
• —Një kthim i fortë mbetet në listën e ndalimeve. suppressions remove e refuzon me 409 suppression_not_removable, dhe removable në çdo rresht e thotë këtë paraprakisht.