SDK
Listimi dhe marrja
`emails.list`, `emails.listAll`, `emails.iterate`, `emails.get` dhe `emails.listEvents`.
emails.list
const first = await openemail.emails.list({ status: ['queued', 'scheduled'], from: '[email protected]', limit: 50,}) const second = first.nextCursor ? await openemail.emails.list({ status: ['queued', 'scheduled'], limit: 50, cursor: first.nextCursor }) : nullNjë faqe është { items, hasMore, nextCursor }. Jepeni nextCursor prapa si cursor, me të njëjtët filtra, për faqen pas saj.
emails.iterate dhe emails.listAll
for await (const email of openemail.emails.iterate({ status: 'failed' })) { console.error(email.id, email.lastError)} const failures = await openemail.emails.listAll({ status: 'failed', from: '[email protected]' })Të dyja e ndjekin nextCursor për ju. iterate merr një faqe vetëm kur cikli arrin tek ajo, pra dalja nga cikli i ndal kërkesat, kurse listAll kalon çdo faqe para se të japë një array të vetëm, prandaj jepini një filtër që ka fund. Faqosje me keyset sido që të jetë, pra një mesazh që mbërrin gjatë përsëritjes nuk mund ta bëjë këtë të kapërcejë një rresht, siç do të ndodhte me offset.
emails.get dhe emails.listEvents
const email = await openemail.emails.get('msg_…')console.log(email.status, email.recipients) const events = await openemail.emails.listEvents('msg_…')for (const event of events) console.log(event.type, event.createdAt)get është e vetmja thirrje që kthen recipients, një rresht për adresë. Një listë me pesëdhjetë mesazhe ku secili mban marrësit e vet është një faqe raporti që nuk e kërkoi askush.
Parametrat
statusEmailStatus | EmailStatus[]- Një status ose disa (`queued`, `scheduled`, `sending`, `sent`, `partial`, `cancelled`, `failed`), duke përputhur cilindo prej atyre që jepen. SDK-ja e dërgon një array si një vlerë të vetme të ndarë me presje sepse serveri e ndan mbi presjet; një vlerë jashtë asaj bashkësie është një 422 që e emërton atë të panjohurën.
fromstring- Përputhje e saktë mbi adresën dërguese ashtu siç u regjistrua, që është `addr@host` i thjeshtë me shkronja të vogla. Rreshti shkruhet me çdo emër shfaqjeje të hequr, pra një angle-addr si `Acme <[email protected]>` nuk përputhet me asgjë. Vlera juaj kthehet në shkronja të vogla para krahasimit, dhe është barazi e jo përputhje prefiksi apo domeni.
limitnumber- Rreshtat në këtë faqe, nga 1 deri në 100, me parazgjedhje 25. Një vlerë jashtë atij intervali refuzohet si 422 në vend që të shtrëngohet brenda tij.
cursorstring- Një id mesazhi (`msg_…`) prej nga fillon faqja. Keyset dhe jo offset: rreshtat kthehen rreptësisht më të vjetër se `createdAt` i atij mesazhi, kështu që dërgimet që mbërrijnë gjatë faqes nuk mund ta shtyjnë një rresht përtej jush. Një id që nuk emërton asnjë mesazh në këtë hapësirë pune është një 400.
Përgjigjja: Page<EmailResource>
itemsEmailResource[]- 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`.
hasMoreboolean- 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.
nextCursorstring | null- Id-ja për ta dhënë prapa si `cursor`, dhe null te faqja e fundit. `iterate` dhe `listAll` ndalojnë kur kjo është null ose kur `hasMore` është false, meqë një faqe që pretendon se ka më shumë pa emërtuar asnjë cursor do të ciklonte pafundësisht.
items[].object'email'- Gjithmonë `'email'` te një rresht i kësaj liste.
items[].idstring- Id-ja e vetë këtij API-je, `msg_…`. Është ajo që merr çdo endpoint tjetër i emails, dhe ajo që emërton një cursor.
items[].statusEmailStatus- 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.
items[].modeApiKeyMode- `live` ose `test`, marrë nga çelësi që e dërgoi. Një dërgim test regjistrohet këtu dhe nuk transmetohet kurrë.
items[].fromstring- Adresa nën të cilën u autorizua dërgimi, e ruajtur e thjeshtë dhe me shkronja të vogla, kështu që një emër shfaqjeje i dhënë te `from` del gjithsesi në rrjet, por nuk ruhet këtu. Një string i thjeshtë dhe jo një objekt, sepse ky është identiteti që u autorizua: një adresë jashtë scope-it të dërgimit të një çelësi, as te një domen që ai e mban, as e emërtuar mbi të, refuzohet me një 403, kurrë nuk zëvendësohet në heshtje me një që ai e ka.
items[].subjectstring | null- Subjekti ashtu siç është ruajtur. Null te një mesazh i regjistruar pa të.
items[].messageIdstring | null- Message-ID sipas RFC 5322, jo id-ja jonë. Null derisa të ekzistojë MIME-i, dhe i rishkruar nga shërbimi dërgues në dalje, pra një bounce ose DSN i mëvonshëm mban një id tjetër dhe korrelon mbi `items[].id`.
items[].threadIdstring | null- Thread-i të cilit i përket ky mesazh, aty ku është dhënë ose caktuar një i tillë. Null përndryshe.
items[].transportEmailTransport | (string & {}) | null- Si u nisën bajtet. Null deri te nisja, dhe e tipizuar hapur, kështu që një transport që kjo SDK nuk e emërton ende nuk është një ndryshim prishës: regjistrat e ruajtur mund të emërtojnë ende të tillë që nuk janë më në përdorim.
items[].attemptsnumber- Sa përpjekje nisjeje ka pasur mesazhi, 0 para të parës.
items[].lastErrorstring | null- Gabimi i fundit i nisjes, i shkruar për një njeri. Null përderisa nuk ka dështuar asgjë.
items[].scheduledAtstring | null- Kur mesazhi duhet të niset, si një çast ISO-8601. Null vetëm te një dërgim i menjëhershëm pa dritare anulimi: një dritare është një vonesë e shkurtër dhe asgjë më shumë, pra edhe `cancellableForSeconds` e mbush këtë, te një rresht `status`-i i të cilit është `queued` dhe jo `scheduled`.
items[].cancellableUntilstring | null- Çasti kur mesazhi duhet të niset, që mban të njëjtën vlerë si `scheduledAt` te çdo dërgim i shtyrë dhe null te një i pashtyrë. Është një timestamp për t'u shfaqur dhe jo testi që bën serveri: `cancel` degëzon mbi `status` dhe e ndal një mesazh vetëm përderisa ai është ende `queued` ose `scheduled`.
items[].sentAtstring | null- Kur u nis. Null derisa nisja të ketë përfunduar, prandaj `status` dhe jo kjo është fusha mbi të cilën duhet degëzuar.
items[].tagsRecord<string, string>- Etiketat e dhëna te dërgimi, të kthyera ashtu siç janë dhe kurrë të interpretuara. Gjithmonë një objekt (`{}` kur nuk është caktuar asnjë, kurrë null), dhe vetëm të kthyera: ky endpoint filtron mbi `status` dhe `from`, pra një etiketë është diçka për ta lexuar te një mesazh dhe jo një mënyrë për të gjetur një të tillë.
items[].sourceEmailSource- Cila sipërfaqe e kërkoi dërgimin: `composer`, `api`, `mcp`, `ai` ose `queue`. `api` është ky klient.
items[].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.
items[].trackingEmailTrackingSummary- 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 `openCount: 0` do të lexohej si "askush nuk e hapi".
items[].tracking.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.
items[].tracking.clicksboolean- Nëse lidhjet e këtij mesazhi u rishkruan. False kur trupi nuk kishte lidhje për të rishkruar, meqë atëherë nuk u ndryshua asgjë.
items[].tracking.openedboolean- Nëse u regjistrua ndonjë hapje e numëruar, e nxjerrë nga `openCount > 0`.
items[].tracking.clickedboolean- Nëse u regjistrua ndonjë klikim i numëruar, i nxjerrë nga `clickCount > 0`.
items[].tracking.openCountnumber- 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ë.
items[].tracking.clickCountnumber- 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.
items[].tracking.firstOpenAtstring | null- Hapja e numëruar më e hershme mbi kopjet, dhe null përderisa nuk ka asnjë. Goditjet e makinave nuk e lëvizin kurrë.
items[].translationEmailTranslationResource- 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`.