Kalo te dokumentacioni
SDK

Regjistri i ndryshimeve

Çdo publikim i paketës, më i riu i pari.

0.1.0

Publikimi i dytë. Kontaktet mund të shkruhen dhe të grupohen në audienca, një domen mund të mbartë emrat e vet të gjurmimit dhe të skedarëve, dhe një çelës mund ta rrotullojë vetveten. Një ndryshim e thyen kodin ekzistues, dhe është listuar më poshtë.

  • openemail.audiences është i ri: lista të emërtuara kontaktesh, me list, get, create, update, delete, listContacts, addContact dhe removeContact. Çdo hapësirë pune ka një audiencë të parazgjedhur, atë builtin-i i së cilës është default, e cila mban çdo kontakt dhe nuk mund të fshihet.
  • openemail.contacts mund të shkruajë. create, update dhe delete i bashkohen list dhe get, dhe secila merr adresën e email-it si id.
  • openemail.domains.update() cakton ose pastron emrin e vet të gjurmimit dhe emrin e skedarëve të një domeni, ndërsa DomainResource.tracking dhe DomainResource.storage raportojnë se ku qëndron secili.
  • openemail.me.rotate() zëvendëson sekretin e çelësit thirrës dhe zgjidhet me çelësin e ri të plotë. Nuk ka dritare mbivendosjeje, prandaj sekreti i vjetër pushon së funksionuari në çastin që kthehet thirrja.
  • KeyResource.domainAllowlist e ngushton një çelës te domene të tëra, pranë adresave individuale te addressAllowlist. Një domen mbulon çdo adresë në të, përfshirë ato të krijuara pas çelësit.
  • Bashkëngjitjet mund të dërgohen me referencë. { fileId } qëndron pranë formës inline, dhe attachmentDelivery zgjedh mes mbartjes së skedarëve brenda mesazhit, zëvendësimit të tyre me lidhje shkarkimi, ose lënies së madhësisë së tyre të vendosë.
  • Dhjetë ngjarje të tjera webhook-u, njëzet gjithsej: përgjigje, dorëzime, vonesa, shtypje, shkarkime dhe tri ngjarjet e domenit.
  • email.downloaded aktivizohet kur një person merr një skedar që u dërgua si lidhje shkarkimi. Një lidhje e vetme u shërben të gjithëve te të cilët shkoi mesazhi, prandaj ngjarja nuk emërton asnjë marrës.
  • Katër scope-e të reja: contacts:write, audiences:read, audiences:write dhe keys:write.
  • Nëntë fusha që ishin vargje të lira tani kanë tipa të emërtuar, mes tyre RecipientKind, ContactSource, RuleMatchMode dhe WebhookDeliveryStatus. Ato pranojnë dhe kthejnë të njëjtat vargje si më parë.
audiences.ts
const audience = await openemail.audiences.create({ name: 'Product updates' }) await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper' })await openemail.audiences.addContact(audience.id, { email: '[email protected]' })

Çfarë thyhet në 0.1.0

  • contacts.list kthen Page<ContactResource> në vend të një vargu. Lexoni rreshtat nga page.items dhe ndiqni page.nextCursor përderisa page.hasMore është true. Libri i adresave është i pakufizuar, ndërsa vargu i vjetër ndalej te 200 rreshta pa e thënë.
  • API_SCOPES, ERROR_TYPES, MESSAGE_ENCRYPTION_FORMATS, RULE_ACTIONS, RULE_FIELDS, RULE_OPERATORS dhe WEBHOOK_EVENTS janë objekte me çelësa dhe jo vargje, prandaj çdo anëtar ka një emër me të cilin mund të thirret. Vlerat janë të pandryshuara.
  • contacts.list i rendit të fundit kontaktet që nuk janë postuar kurrë, në vend që t'i vërë të parët, prandaj një kontakt që sapo krijuat nuk kërcen më në krye të librit.
migrate.ts
import { API_SCOPES, WEBHOOK_EVENTS } from '@openemail/sdk' const scopes = Object.values(API_SCOPES)const subscribable = new Set<string>(Object.values(WEBHOOK_EVENTS)) const page = await openemail.contacts.list()for (const contact of page.items) send(contact.email)

Kodi që përdorte vetëm tipat e derivuar vazhdon të punojë pa u prekur. ApiScope, WebhookEvent dhe të tjerët janë të njëjtët tipa si më parë.

0.0.1

Publikimi i parë: një metodë e tipizuar për çdo endpoint, dhe asnjë varësi runtime.

  • Dërgimi: një mesazh i vetëm, grupe, dërgime të planifikuara, një dritare zhbërjeje, dhe përkthim në gjuhën që lexon marrësi.
  • Shabllonet: krijim, versionim, publikim, paraparje dhe dërgim.
  • Gjurmimi: hapjet, klikimet dhe një përmbledhje për çdo mesazh.
  • Kutia postare: bisedat, skicat, etiketat, kontaktet dhe rregullat.
  • Hapësira e punës: domenet, adresat, anëtarët, rolet dhe cilësimet.
  • Webhook-ët, me një verifikues nënshkrimi që ekzekutohet kudo ku ekzekutohet WebCrypto.
  • Ngjarjet e kalendarit, përfshirë skedarin ICS.
  • Inbox-et e përkohshëm, e vetmja pjesë që ekzekutohet edhe në shfletues.
  • Faqezim me kursor në çdo listë, përmes listAll dhe iterate.
  • Dy klasa gabimesh, dhe riprovime që nuk mund ta dyfishojnë një dërgim.
  • ESM dhe CommonJS, në Node 20+, Bun, Deno dhe Cloudflare Workers.