SDK

Etykiety

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

Wszystkie 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 rozwiązuje się do zwykłej tablicy, bo etykiety nie są stronicowane. color jest zwracany przy odczytach, a nie pomijany, żeby klient mógł wyrenderować etykietę tak, jak widzi ją użytkownik. type zawsze ma wartość user, więc nie ma na czym się rozgałęziać. Identyfikatory wywodzą się z nazwy, więc Invoices to USER_INVOICES.

Parametry: labels.create i labels.update

namestringwymagane: Nazwa wyświetlana etykiety, przycinana przed pomiarem, więc limit to 1 do 225 znaków po przycięciu. Sama biała spacja to 422, a nie bezimienny wiersz z kolorową kropką, którego nie ma jak przeczytać ani kliknąć. `create` odrzuca dodatkowo, gdy skrzynka ma już 50 etykiet użytkownika, z 422 `label_limit_reached` nazywającym `name`.
colorLabelColor: Opcjonalne w obu wywołaniach, a pominięcie go w `update` zostawia zapisany kolor w spokoju, zamiast go czyścić. Treść jest ścisła, więc bliski klucz w rodzaju `colour` to 422, a nie cicha bezczynność.
color.backgroundColorstringwymagane: Wymagane, gdy podano `color`, najwyżej 32 znaki. W natywnej skrzynce to jedyna zachowywana połowa: wiersz przechowuje jeden kolor.
color.textColorstringwymagane: Wymagane, gdy podano `color`, najwyżej 32 znaki.

Odpowiedź: Label

object'label': Zawsze ciąg `label`. Zapis też go zwraca, na `SavedLabelResource`, a nie na tym typie.
idstring: Własny identyfikator skrzynki, przyjmowany przez `get`, `update` i `delete`. Przy zapisie przychodzi jako `SavedLabelResource.id`, które może być null. Gdy jest null, znajdź etykietę, listując.
namestring: To, co widzi użytkownik, i pusty ciąg zamiast null, gdy skrzynka odda etykietę bez nazwy. W natywnej skrzynce identyfikator wywodzi się z tej nazwy (`Follow up` staje się `USER_FOLLOW_UP`), więc druga etykieta normalizująca się do tego samego identyfikatora jest odrzucana z 409 `label_name_taken`, zamiast nadpisać pierwszą.
typestring: Zawsze `user`. Serwowane są tu tylko etykiety użytkownika: standardowe identyfikatory folderów są odfiltrowywane przed zbudowaniem odpowiedzi, a systemowy identyfikator w `get` daje 404. Trasa spada do `user`, gdy skrzynka pomija to pole, a nic w `LabelInput` go nie ustawia.
colorLabelColor | null: Null, gdy skrzynka nie raportuje koloru dla etykiety. Testuj ciągi znaków, a nie sam obiekt, przed renderowaniem. Pusta para to nie to samo co brak pary.
color.backgroundColorstring: Tło etykiety w postaci, w jakiej trzyma je skrzynka. Zwracane, a nie pomijane, żeby klient mógł wyrenderować etykietę tak, jak użytkownik widzi ją w aplikacji.
color.textColorstring: Kolor pierwszego planu. Natywna skrzynka nie ma na niego kolumny: odczyty zwracają `#ffffff` niezależnie od tego, co zapisano, więc jasne tło wraca z nieczytelnym tekstem na nim.