SDK

Címkék

`labels.list`, `get`, `create`, `update` és `delete`.

Minden metódus

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!)

A list egyszerű tömbbel tér vissza, mivel a címkék nincsenek lapozva. A color az olvasásoknál nem esik el, hanem visszajön, így a kliens úgy jelenítheti meg a címkét, ahogy a felhasználó látja. A type mindig user, tehát nincs mire elágazni. Az azonosítók a névből származnak, így az Invoices azonosítója USER_INVOICES.

Paraméterek: labels.create és labels.update

namestringkötelező: A címke megjelenített neve, amelyet mérés előtt levág a rendszer, így a korlát levágás után 1–225 karakter. A csupa szóköz 422-t kap, nem pedig egy név nélküli sort színes ponttal, amin nincs mit elolvasni vagy amire kattintani. A `create` ezen felül elutasítja a kérést, ha a postafiók már 50 felhasználói címkét tartalmaz: 422 `label_limit_reached`, a `name` megnevezésével.
colorLabelColor: Mindkét híváson opcionális, és ha az `update` során elhagyod, a tárolt szín érintetlen marad, nem törlődik. A törzs szigorú, így egy majdnem eltalált kulcs, mint a `colour`, 422-t kap, nem pedig csendben hatástalan marad.
color.backgroundColorstringkötelező: Kötelező, ha megadtad a `color` mezőt, és legfeljebb 32 karakter. A natív postafiókban csak ez a fele marad meg: a sor egyetlen színt tárol.
color.textColorstringkötelező: Kötelező, ha megadtad a `color` mezőt, és legfeljebb 32 karakter.

Válasz: Label

object'label': Mindig a `label` string. Írásnál is visszajön, de `SavedLabelResource`-on, nem ezen a típuson.
idstring: A postafiók saját azonosítója, és ezt várja a `get`, az `update` és a `delete`. Írásnál `SavedLabelResource.id` néven érkezik, amely lehet null. Ha null, listázással keresd meg a címkét.
namestring: Amit a felhasználó lát; ha a postafiók név nélküli címkét ad vissza, üres string jön null helyett. A natív postafiókban az azonosító ebből a névből képződik (a `Follow up`-ból `USER_FOLLOW_UP` lesz), így egy másik címke, amely ugyanarra az azonosítóra normalizálódik, 409 `label_name_taken` hibát kap, nem pedig felülírja az elsőt.
typestring: Mindig `user`. Itt csak felhasználói címkék szolgálódnak ki: a szabványos mappaazonosítókat a válasz összeállítása előtt kiszűri a rendszer, a `get` hívásban megadott rendszerazonosító pedig 404. Az útvonal `user` értékre esik vissza, ha a postafiók elhagyja a mezőt, és a `LabelInput`-ban semmi nem állítja be.
colorLabelColor | null: Null, ha a postafiók nem jelent színt a címkéhez. Megjelenítés előtt a stringeket vizsgáld, ne az objektumot. Az üres pár nem ugyanaz, mint a hiányzó.
color.backgroundColorstring: A címke háttérszíne úgy, ahogy a postafiók tárolja. Nem esik el, hanem visszajön, így a kliens úgy jelenítheti meg a címkét, ahogy a felhasználó az alkalmazásban látja.
color.textColorstring: Az előtérszín. A natív postafiókban nincs rá oszlop: az olvasás `#ffffff` értéket ad vissza, bármit is írtak be, így a halvány háttérhez olvashatatlan szöveg társul.