Transmetime

import time from openemail import openemailfrom openemail.types import BroadcastCreate draft: BroadcastCreate = {    '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>',    'text': 'Hi {{firstName|there}}, here is what changed this month. Unsubscribe: {{unsubscribeUrl}}',    'tags': {'campaign': 'release-2026-09'},} reach = openemail.broadcasts.preview(draft)print(reach['recipients'], reach['unsubscribed'], reach['suppressed']) broadcast = openemail.broadcasts.send(draft) latest = openemail.broadcasts.get(broadcast['id'])while latest['status'] in ('scheduled', 'queued', 'sending'):    time.sleep(5)    latest = openemail.broadcasts.get(broadcast['id']) for copy in openemail.broadcasts.iterate_recipients(broadcast['id']):    print(copy['email'], copy['status'], copy['opens'], copy['clicks']) bounced = openemail.broadcasts.list_recipients(broadcast['id'], filter='bounced')if bounced['items']:    content = openemail.broadcasts.get_recipient(broadcast['id'], bounced['items'][0]['emailId'])    print(content['subject'], content['bouncedAt']) stats = openemail.broadcasts.stats(broadcast['id'], grain='day')print(stats['totals']['opened'], stats['totals']['clicked'], stats['totals']['unsubscribed']) lately = openemail.broadcasts.stats(broadcast['id'], days=1)print(lately['window']['opened'] if lately['window'] else None) month = openemail.broadcasts.analytics(days=30)for row in month['broadcasts']:    print(row['subject'], row['sent'], row['opened']) later = openemail.broadcasts.send({**draft, 'scheduledAt': 'P1D'})openemail.broadcasts.cancel(later['id']) history = openemail.broadcasts.list(audience_id=draft['audienceIds'][0])print(latest['status'], latest['counts']['sent'], len(history['items']))

Një transmetim dërgon një mesazh te të gjithë në një ose më shumë audienca, si kopje më vete për çdo person. Çdo kopje ka saktësisht një marrës dhe as cc as bcc, ndaj askush nuk sheh se kujt tjetër i shkoi, dhe çdo kopje është një email i zakonshëm me id-në e vet msg_, ngjarje, gjurmim dhe webhook-e. list_recipients i rendit me atë që ndodhi me secilën. Kopjet nuk ruhen në dosjen Të dërguarat, sepse transmetimi është regjistrimi.

send kthehet menjëherë me transmetimin queued, ose scheduled kur jepni scheduledAt, dhe dërgimi vazhdon në sfond. send kërkon emails:send dhe audiences:read, preview kërkon audiences:read, list, list_all, iterate, get, list_recipients, list_all_recipients, iterate_recipients, get_recipient, stats dhe analytics kërkojnë emails:read, dhe cancel kërkon emails:send.

subject, html dhe text plotësohen për çdo person nga kontakti i tij. {{firstName}} është fjala e parë e emrit të kontaktit, {{lastName}} pjesa tjetër, {{name}} emri i plotë, {{email}} adresa ku shkon kopja dhe {{unsubscribeUrl}} lidhja që e çregjistron.

Çdo fushë pranon një vlerë rezervë pas një vije, e përdorur kur kontakti nuk ka vlerë për të, ndaj {{firstName|there}} bëhet "there" për një kontakt të ruajtur pa emër. Vlerat maskohen në html, dhe çdo {{…}} tjetër lihet saktësisht siç është shkruar.

Jepni template në vend të html dhe text për të dërguar një shabllon të ruajtur. Të njëjtat pesë vlera i arrijnë si props, por vetëm props-et që shablloni deklaron, ndaj një shabllon që deklaron firstName e merr dhe një që nuk e deklaron nuk refuzohet kurrë për këtë. Gjithçka te template.props shkon njësoj në çdo kopje.

Çdo kopje mban kokat e çregjistrimit me një klikim që i lejojnë një klienti poste të shfaqë butonin e vet të çregjistrimit, gjë që kërkojnë ofruesit e mëdhenj të kutive postare nga posta masive. Një trup html ose text që nuk e vendos vetë {{unsubscribeUrl}} merr një fundfaqe me një rresht me lidhjen. Një shabllon dërgohet saktësisht ashtu siç është, ndaj vendosni {{unsubscribeUrl}} në shabllon.

Çregjistrimi e shënon personin të çregjistruar në çdo audiencë ku shkoi ai transmetim, dhe AudienceContactResource.unsubscribedAt e tregon këtë te audiences.list_contacts. Ai mbetet në audiencë dhe në librin e adresave, audiencat e tjera nuk preken, dhe posta që i dërgohet një mesazh në herë vazhdon të dalë. Heqja nga audienca dhe shtimi sërish e regjistron përsëri.

Një transmetim arrin çdo kontakt në të paktën një nga audienceIds, një herë sado prej tyre ta mbajnë. Kapërcen një kontakt që është çregjistruar nga çdo prej atyre audiencave ku ndodhet, dhe një adresë në listën e bllokimit pas një kthimi ose ankese, ose sepse dikush e shtoi aty. Një kontakt i shtuar në një nga audiencat pas send, por para se dërgimi ta arrijë, përfshihet.

preview kthen të njëjtët numra pa dërguar: recipients, unsubscribed dhe suppressed. Një send që nuk do të arrinte askënd ngre 422 no_recipients.

get i lexon counts drejtpërdrejt nga kopjet, ndaj pyeteni ndërsa një transmetim dërgon. status kalon nga scheduled ose queued te sending dhe ngulet te sent pasi çdo kopje e dorëzuar ka dalë ose ka dështuar. Mbetet sending sa kohë kopjet ende presin, edhe pasi completedAt thotë se u arrit personi i fundit. failed do të thotë se i gjithë transmetimi u ndal, dhe lastError tregon pse: nga adresa from nuk mund të dërgohet më, shablloni pushoi së zgjidhuri, plani mbaroi në mes të rrugës, vetë dërgimi vazhdoi të dështonte, ose nuk u shkrua dot asnjë kopje.

cancel ndal një transmetim që është scheduled, queued ose sending. Nuk shtohet askush tjetër dhe çdo kopje që pret ende anulohet, ndërsa kopjet që kanë dalë nuk mund të tërhiqen. Pasi ka dalë çdo kopje, cancel ngre 409 broadcast_not_cancellable, dhe anulimi i një transmetimi të anuluar e kthen atë ashtu siç është.

list_recipients kthen një faqe me personat të cilëve u shkoi një transmetim, një rresht për kopje, të renditur sipas adresës, si një dict me items, hasMore dhe nextCursor. list_all_recipients i kalon të gjitha faqet në një listë të vetme dhe iterate_recipients jep një kopje në një kohë, duke marrë faqen tjetër vetëm kur cikli e kërkon. limit shkon nga 1 deri në 200 me parazgjedhje 50, dhe një cursor kthehet me të njëjtat filter dhe q.

BROADCAST_RECIPIENT_FILTERS emërton çdo filtër, dhe q kërkon në adresë dhe emër, pa dallim mes shkronjave të mëdha dhe të vogla. Hapjet dhe klikimet lënë jashtë proxy-t e imazheve dhe skanerët e lidhjeve, dhe mbeten 0 kur transmetimi u nis me gjurmimin të fikur.

get_recipient(id, email_id) kthen një kopje: i njëjti rresht, plus subject, html dhe text saktësisht siç i mori ai person, me fushat e bashkimit të plotësuara dhe lidhjen e vet të çregjistrimit. HTML-ja është nga para se të shtohej gjurmimi i hapjeve dhe klikimeve. Një email_id që nuk është kopje e këtij transmetimi ngre 404 recipient_not_found, dhe një transmetim i panjohur ngre 404 broadcast_not_found.

stats kthen totalet dhe një seri. totals numëron kopjet sent, delivered, bounced, complained dhe failed, me pending për ato që ende presin, dhe personat që opened, clicked dhe unsubscribed, me opens dhe clicks si numërime ngjarjesh. series është e rrallë dhe fillon nga më e vjetra, një interval për çdo grain (minute, hour ose day, me parazgjedhje hour) në të cilin ndodhi diçka, i ndarë sipas offset_minutes në lindje të UTC. Ajo e numëron çdo person një herë, në momentin e parë kur i ndodhi, ndaj shuma përputhet me totalet.

get dhe cancel kthejnë secila një të tillë, dhe send kthen një SentBroadcastResource, të njëjtat fusha plus replayed, që është True kur përgjigjja është transmetimi që krijoi një thirrje e mëparshme me të njëjtin çelës idempotence. list kthen një faqe me to, një dict me items, hasMore dhe nextCursor, nga më i riu, dhe list_all e iterate përshkojnë të gjitha faqet. preview kthen një BroadcastPreviewResource me audienceIds, recipients, unsubscribed dhe suppressed. list_recipients kthen një faqe me rreshta BroadcastRecipientResource, get_recipient një BroadcastRecipientContentResource dhe stats një BroadcastStatsResource.

Çdo rresht i list_recipients, list_all_recipients dhe iterate_recipients. BroadcastRecipientContentResource, nga get_recipient, shton subject, html dhe text.

• broadcasts.preview()Referenca e plotë
• broadcasts.send()Referenca e plotë
• broadcasts.list()Referenca e plotë
• broadcasts.list_all()Referenca e plotë
• broadcasts.iterate()Referenca e plotë
• broadcasts.get()Referenca e plotë
• broadcasts.list_recipients()Referenca e plotë
• broadcasts.list_all_recipients()Referenca e plotë
• broadcasts.iterate_recipients()Referenca e plotë
• broadcasts.get_recipient()Referenca e plotë
• broadcasts.stats()Referenca e plotë
• broadcasts.analytics()Referenca e plotë
• broadcasts.cancel()Referenca e plotë