Ruby

Listimi dhe marrja

`emails.list`, `emails.list_all`, `emails.iterate`, `emails.get` dhe `emails.list_events`.

emails.list

list_emails.rb

filters = {status: ["queued", "scheduled"], from: "[email protected]"} first = client.emails.list(**filters, limit: 50)second = client.emails.list(**filters, limit: 50, cursor: first.next_cursor) if first.next_cursor p first.items.size, second&.items&.size

Një faqe është një OpenEmail::Page me items, has_more? dhe next_cursor. Për faqen pas saj, jepeni next_cursor prapa si cursor:, me të njëjtët filtra.

emails.iterate dhe emails.list_all

iterate_emails.rb

client.emails.iterate(status: "failed") do |email|  warn "#{email[:id]} #{email[:lastError]}"end failures = client.emails.list_all(status: "failed", from: "[email protected]")puts failures.size

Të dyja ndjekin next_cursor për ju. iterate merr një faqe vetëm kur përshkimi arrin aty, ndaj break në bllok, ose first a find mbi Enumerator-in që kthen pa bllok, i ndalojnë kërkesat, ndërsa list_all i përshkon të gjitha faqet para se të kthejë një Array të vetëm, ndaj jepini një filtër që ka fund. Në të dyja rastet faqosja bëhet sipas çelësit (keyset), ndaj një mesazh që mbërrin në mes të përshkimit nuk mund të bëjë që të kapërcehet një rresht, siç do të ndodhte me një zhvendosje (offset).

emails.get dhe emails.list_events

get_email.rb

email = client.emails.get("msg_3f9a1c07d2b84e6a9c5b1f20")puts email[:status]p email[:recipients] events = client.emails.list_all_events("msg_3f9a1c07d2b84e6a9c5b1f20")events.each { |event| puts "#{event[:type]} #{event[:createdAt]}" }

get është e vetmja thirrje që kthen recipients, një Hash për çdo adresë me status, error dhe deliveredAt të vetat. Një listë me pesëdhjetë mesazhe, secili me marrësit e vet, do të ishte një faqe raporti që nuk e ka kërkuar askush.

list_events lexon gjurmën e ngjarjeve të një dërgimi, nga më e vjetra: email.accepted, email.queued, email.sent, email.delivered, email.bounced, email.opened dhe të tjerat, secila me një Hash data forma e të cilit varet nga type i saj. list_all_events dhe iterate_events e përshkojnë gjithë gjurmën për ju. Webhook-et dërgojnë një nënbashkësi të të njëjtave ngjarje ndërsa ndodhin, ndaj këtu duhet të shikoni kur një webhook ka humbur.

Parametrat

statusString or Array<String>: Një status ose disa (`queued`, `scheduled`, `sending`, `sent`, `partial`, `bounced`, `cancelled`, `failed`), që përputhen me cilindo prej atyre të dhëna. `bounced` do të thotë se mesazhi u kthye nga çdo marrës te i cili shkoi, ndërsa një mesazh që u kthye për disa dhe arriti te të tjerët shfaqet si `partial`. Gem-i e dërgon një Array si një vlerë të vetme të ndarë me presje, sepse serveri ndan sipas presjeve, dhe një vlerë jashtë bashkësisë jep një 422 që e emërton vlerën e panjohur.
broadcast_idString: Vetëm kopjet e një transmetimi, një id `brd_` nga `broadcasts.send`. Çdo person që arrin një transmetim merr një mesazh të vetin, ndaj kjo liston kujt i shkoi dhe çfarë ndodhi me çdo kopje. `broadcasts.list_recipients` liston të njëjtët njerëz me hapjet, klikimet dhe çregjistrimet e tyre.
fromString: Përputhje e saktë me adresën dërguese siç u regjistrua, që është `addr@host` e zhveshur me shkronja të vogla. Rreshti shkruhet pa emrin e shfaqjes, ndaj një adresë me kllapa këndore si `Acme <[email protected]>` nuk përputhet me asgjë. Vlera juaj kthehet në shkronja të vogla para krahasimit, dhe krahasimi bëhet sipas barazisë, jo sipas prefiksit apo domenit.
scheduled_fromTime, DateTime or String: Vetëm mesazhet e planifikuara për këtë çast ose më vonë. Me `scheduled_to:` dhe `status: ["scheduled", "queued"]` liston çfarë pret të niset brenda një dritareje kohore, ashtu siç bën kalendari i aplikacionit. Një mesazh pa `scheduledAt` lihet jashtë. Jepni një Time, një DateTime ose një çast ISO 8601 me zhvendosjen e tij: një Date e Ruby-t dërgohet si datë e zhveshur, të cilën këta dy filtra e refuzojnë.
scheduled_toTime, DateTime or String: Vetëm mesazhet e planifikuara për këtë çast ose më herët. Një `scheduled_from:` pas `scheduled_to:` jep një 422 `invalid_parameter`.
limitInteger: Rreshtat në këtë faqe, nga 1 deri në 100, me 25 si parazgjedhje. Një vlerë jashtë këtij diapazoni refuzohet me 422 në vend që të kufizohet. Te `list_all` dhe `iterate` është madhësia e çdo faqeje që marrin.
cursorString: Një id mesazhi (`msg_…`) nga e cila të faqosni. Sipas çelësit (keyset) dhe jo sipas zhvendosjes: rreshtat kthehen rreptësisht më të vjetër se `createdAt` i atij mesazhi, ndaj dërgimet që mbërrijnë në mes të faqes nuk mund ta shtyjnë një rresht përtej jush. Një id që nuk emërton asnjë mesazh në këtë hapësirë pune jep një 400 `invalid_cursor`.
api_keyString: Liston me këtë çelës në vend të atij të klientit.

Një çelës i ngushtuar te disa adresa lexon vetëm mesazhet e dërguara nga adresat që mbulon, dhe faqja pritet pas atij filtri, ndaj çdo faqe përveç së fundit mban prapëseprapë limit rreshta. Një from: që çelësi nuk e mbulon kthen një faqe të fundit bosh dhe jo një 403.

Përgjigjja: OpenEmail::Page

itemsArray<Hash>: Një faqe mesazhesh, më të rejat të parat sipas `createdAt`, e nxjerrë nga zarfi `data` i API-së. Rreshtat e listës nuk mbajnë kurrë ndarjen `recipients` sipas adresës. Ajo është te `get`.
has_more?Boolean: Nëse përputhen me filtrin edhe rreshta të tjerë përtej kësaj faqeje. Përgjigjet duke marrë një rresht më shumë se `limit` në vend të një query-je të dytë numërimi.
next_cursorString or nil: Id-ja që jepet prapa si `cursor:`, dhe nil në faqen e fundit. `iterate` dhe `list_all` ndalojnë kur kjo është nil ose `has_more?` është false, sepse një faqe që pretendon se ka më shumë pa emërtuar asnjë cursor do të përsëritej pafundësisht.

Çdo element

objectString: Gjithmonë `email` te një rresht i kësaj liste.
idString: Id-ja e vetë kësaj API-je, `msg_…`. Është ajo që merr çdo thirrje tjetër e emails dhe ajo që emërton një cursor.
statusString: Ku ndodhet mesazhi në jetën e tij. `partial` është një gjendje më vete dhe jo një nuancë e failed: disa marrës e kanë dhe nuk mund t'u hiqet, pra riprovimi është i gabuar. `bounced` do të thotë se u kthye nga çdo marrës pasi u nis, kështu që askush nuk e ka, dhe çdo marrës te `get` tregon pse.
modeString: `live` ose `test`, marrë nga çelësi që e dërgoi. Një dërgim test regjistrohet këtu dhe nuk transmetohet kurrë.
fromString: Adresa nën të cilën u autorizua dërgimi, e ruajtur e zhveshur dhe me shkronja të vogla, ndaj një emër shfaqjeje i dhënë te `from` del prapëseprapë në rrjet, por nuk ruhet këtu. Një String i thjeshtë dhe jo një Hash, sepse ky është identiteti që u autorizua: një adresë jashtë fushës së dërgimit të një çelësi, që as nuk është në një domen që ai mban, as nuk emërtohet në të, refuzohet me një 403 dhe nuk zëvendësohet kurrë në heshtje me një adresë që e mbulon.
subjectString or nil: Subjekti siç është ruajtur. nil te një mesazh i regjistruar pa subjekt.
messageIdString or nil: Message-ID sipas RFC 5322, jo id-ja jonë. nil derisa të ekzistojë MIME-ja, dhe e rishkruar nga shërbimi i dërgimit në dalje, ndaj një kthim ose DSN i mëvonshëm mbart një id tjetër dhe lidhet përmes `id` në vend të saj.
threadIdString or nil: Thread-i të cilit i përket ky mesazh, kur u dha ose u caktua një i tillë. Përndryshe nil.
transportString or nil: Si u nisën bajtet. nil deri në nisje. Regjistrat e ruajtur mund të emërtojnë ende transporte që nuk përdoren më, ndaj trajtojeni një vlerë që nuk e njihni si informacion dhe jo si gabim.
attemptsInteger: Sa përpjekje nisjeje ka pasur mesazhi, 0 para të parës.
lastErrorString or nil: Gabimi më i fundit i nisjes, i shkruar për një person. nil sa kohë që asgjë nuk ka dështuar.
scheduledAtString or nil: Kur duhet të niset mesazhi, si çast ISO 8601. nil vetëm te një dërgim i menjëhershëm pa dritare anulimi: një dritare është thjesht një vonesë e shkurtër, ndaj edhe `cancellableForSeconds` e plotëson këtë, te një rresht `status` i të cilit është `queued` dhe jo `scheduled`.
cancellableUntilString or nil: Çasti kur mesazhi duhet të niset, me të njëjtën vlerë si `scheduledAt` te çdo dërgim që u shty dhe nil te një dërgim që nuk u shty. Është një vulë kohore për t’u shfaqur, jo kontrolli që bën serveri: `cancel` vendos sipas `status` dhe e ndalon një mesazh vetëm sa kohë që është ende `queued` ose `scheduled`.
sentAtString or nil: Kur u nis. nil derisa të përfundojë nisja, prandaj fusha sipas së cilës duhet vendosur është `status` dhe jo kjo.
tagsHash: Etiketat e dhëna gjatë dërgimit, të kthyera ashtu siç janë dhe kurrë të interpretuara. Gjithmonë një Hash, bosh kur nuk është vendosur asnjë dhe kurrë nil, dhe vetëm të kthyera: kjo listë filtron sipas `status`, `from`, `broadcast_id` dhe dritares së planifikimit, ndaj një etiketë është diçka që lexohet nga një mesazh, jo një mënyrë për ta gjetur.
broadcastIdString or nil: Transmetimi `brd_` nga i cili ky mesazh është një kopje, ose nil për një mesazh të dërguar më vete.
sourceString: Cila sipërfaqe e kërkoi dërgimin: `composer`, `api`, `mcp`, `ai` ose `queue`. `api` është ky klient.
createdAtString: Kur u shkrua regjistri i dërgimit, që është para nisjes. Kjo është fusha sipas së cilës rendit lista dhe fusha me të cilën krahasohet një cursor.
trackingHash: Përmbledhja e angazhimit, e pranishme vetëm te një rresht mesazhi i të cilit u gjurmua dhe e munguar përndryshe. Mungesa është përgjigjja për “a u gjurmua ky”, aty ku një `openCount` prej 0 do të lexohej si “askush nuk e hapi”.
translationHash: Kurrë e pranishme te një rresht liste: regjistri i përkthimit ndodhet te kërkesa e ruajtur, të cilën një listë me qëllim nuk e merr. Mungesa e tij këtu nuk thotë asgjë për faktin nëse mesazhi u përkthye. Pyesni `get`.

Gjurmimi i një elementi

opensBoolean: Nëse ky mesazh u nis me një piksel. Ajo që u zbatua mbi këtë mesazh, jo ajo që thotë cilësimi i llogarisë tani.
clicksBoolean: Nëse lidhjet e këtij mesazhi u rishkruan. False kur trupi nuk kishte lidhje për t’u rishkruar, sepse atëherë nuk ndryshoi asgjë.
openedBoolean: Nëse u regjistrua ndonjë hapje e numëruar, e nxjerrë nga `openCount` mbi 0.
clickedBoolean: Nëse u regjistrua ndonjë klikim i numëruar, i nxjerrë nga `clickCount` mbi 0.
openCountInteger: Hapje që besohet se i shkaktoi një person, të mbledhura mbi çdo kopje të mesazhit. Skanuesit dhe proxy-t e privatësisë regjistrohen, por përjashtohen, dhe marrjet e përsëritura brenda tridhjetë sekondave bashkohen në një.
clickCountInteger: Klikime të numëruara, të mbledhura mbi kopjet. Të deduplikuara për lidhje dhe jo për mesazh, sepse ndjekja e dy lidhjeve me disa sekonda diferencë janë dy veprime dhe jo një përsëritje.
firstOpenAtString or nil: Hapja e numëruar më e hershme mbi kopjet, dhe nil përderisa nuk ka asnjë. Goditjet e makinave nuk e lëvizin kurrë.