SDK

Etiketat

`labels.list`, `get`, `create`, `update` dhe `delete`.

Të gjitha metodat

usage.ts

const labels = await openemail.labels.list()const label = await openemail.labels.get('USER_INVOICES') const created = await openemail.labels.create({  name: 'Invoices',  color: { backgroundColor: '#e8eaed', textColor: '#3c4043' },}) await openemail.labels.update(created.id!, { name: 'Invoices 2027' })await openemail.labels.delete(created.id!)

list jep një array të thjeshtë, meqë etiketat nuk faqosen. color kthehet te leximet në vend që të hiqet, kështu që një klient mund ta shfaqë etiketën ashtu si e sheh përdoruesi. type është gjithmonë user, pra nuk ka mbi çfarë të degëzohet. Id-të nxirren nga emri, pra Invoices është USER_INVOICES.

Parametrat: labels.create dhe labels.update

namestringe detyrueshme: Emri i shfaqur i etiketës, i pastruar nga hapësirat para se të matet, pra kufiri është nga 1 deri në 225 karaktere pas pastrimit. Vetëm hapësira është një 422 dhe jo një rresht pa emër me një pikë ngjyre dhe asgjë për të lexuar a për të klikuar. `create` refuzon gjithashtu sapo kutia postare mban tashmë 50 etiketa përdoruesi, me një 422 `label_limit_reached` që emërton `name`.
colorLabelColor: Opsional te të dyja thirrjet, dhe lënia e tij jashtë te `update` e lë ngjyrën e ruajtur të paprekur në vend që ta pastrojë. Trupi është strikt, pra një çelës gati i njëjtë si `colour` është një 422 dhe jo një veprim i heshtur pa efekt.
color.backgroundColorstringe detyrueshme: I detyrueshëm sapo jepet `color`, dhe me më së shumti 32 karaktere. Te kutia postare vendase kjo është e vetmja gjysmë që ruhet: rreshti ruan një ngjyrë të vetme.
color.textColorstringe detyrueshme: I detyrueshëm sapo jepet `color`, dhe me më së shumti 32 karaktere.

Përgjigjja: Label

object'label': Gjithmonë stringu `label`. Edhe një shkrim e kthen, te një `SavedLabelResource` dhe jo te ky tip.
idstring: Id-ja e vetë kutisë postare, dhe ajo që marrin `get`, `update` dhe `delete`. Te një shkrim ajo mbërrin si `SavedLabelResource.id`, e cila mund të jetë null. Kur është null, gjejeni etiketën duke listuar.
namestring: Ajo që sheh përdoruesi, dhe një string bosh e jo null kur kutia postare kthen një etiketë pa të. Te kutia postare vendase id-ja nxirret nga ky emër (`Follow up` bëhet `USER_FOLLOW_UP`), kështu që një etiketë e dytë që normalizohet te e njëjta id refuzohet me një 409 `label_name_taken` në vend që të mbishkruajë të parën.
typestring: Gjithmonë `user`. Këtu shërbehen vetëm etiketat e përdoruesit: id-të e dosjeve standarde filtrohen para se të ndërtohet përgjigjja, dhe një id sistemi te `get` është një 404. Rruga bie te `user` kur kutia postare e lë fushën jashtë, dhe asgjë te `LabelInput` nuk e cakton.
colorLabelColor | null: Null kur kutia postare nuk raporton asnjë ngjyrë për etiketën. Testoni stringjet dhe jo objektin para se të shfaqni. Një çift bosh nuk është e njëjta gjë me një të munguar.
color.backgroundColorstring: Sfondi i etiketës ashtu siç e mban kutia postare. I kthyer në vend që të hiqet, kështu që një klient mund ta shfaqë etiketën ashtu si e sheh përdoruesi në aplikacion.
color.textColorstring: Ngjyra e tekstit. Kutia postare vendase nuk ka kolonë për të: leximet kthejnë `#ffffff` sido që të jetë shkruar, pra një sfond i zbehtë kthehet me tekst të palexueshëm mbi të.