SDK

Štítky

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

Všechny metody

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 se vyhodnotí na prosté pole, protože štítky se nestránkují. color se při čtení vrací, místo aby se zahazovala, takže klient může štítek vykreslit tak, jak ho vidí uživatel. type je vždy user, takže není podle čeho se větvit. Id se odvozují z názvu, takže Invoices je USER_INVOICES.

Parametry: labels.create a labels.update

namestringpovinné: Zobrazovaný název štítku, ořezaný o okolní mezery ještě před měřením, takže limit je 1 až 225 znaků po ořezání. Samotné bílé znaky jsou 422, ne bezejmenný řádek s barevnou tečkou a ničím ke čtení nebo kliknutí. `create` navíc odmítne, jakmile schránka už obsahuje 50 uživatelských štítků, a to s 422 `label_limit_reached` u pole `name`.
colorLabelColor: Volitelné u obou volání; vynechání u `update` ponechá uloženou barvu beze změny, místo aby ji smazalo. Tělo je striktní, takže klíč jen o kousek vedle, například `colour`, je 422, ne tiché nicnedělání.
color.backgroundColorstringpovinné: Povinné, jakmile zadáte `color`, a nejvýše 32 znaků. V nativní schránce je to jediná polovina, která se uchová: řádek ukládá jedinou barvu.
color.textColorstringpovinné: Povinné, jakmile zadáte `color`, a nejvýše 32 znaků.

Odpověď: Label

object'label': Vždy řetězec `label`. Zápis jej vrací také, ale na `SavedLabelResource`, ne na tomto typu.
idstring: Vlastní id schránky a to, co přijímají `get`, `update` a `delete`. Při zápisu přichází jako `SavedLabelResource.id`, které může být null. Když je null, najděte štítek výpisem.
namestring: To, co vidí uživatel; když schránka vrátí štítek bez názvu, je to prázdný řetězec, ne null. V nativní schránce se id odvozuje z tohoto názvu (`Follow up` se stane `USER_FOLLOW_UP`), takže druhý štítek, který se normalizuje na stejné id, je odmítnut s 409 `label_name_taken`, místo aby ten první přepsal.
typestring: Vždy `user`. Vydávají se zde jen uživatelské štítky: id standardních složek se odfiltrují ještě před sestavením odpovědi a systémové id v `get` je 404. Když schránka toto pole vynechá, route se vrátí k `user`, a nic v `LabelInput` je nenastavuje.
colorLabelColor | null: Null, když schránka pro štítek žádnou barvu nehlásí. Před vykreslením testujte jednotlivé řetězce, ne objekt. Prázdná dvojice není totéž co chybějící.
color.backgroundColorstring: Pozadí štítku tak, jak jej schránka drží. Vrací se, místo aby se zahodilo, aby klient mohl štítek vykreslit tak, jak jej uživatel vidí v aplikaci.
color.textColorstring: Barva popředí. Nativní schránka pro ni nemá sloupec: čtení vrací `#ffffff` bez ohledu na to, co se zapsalo, takže světlé pozadí se vrátí s nečitelným textem.