SDK

Libellés

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

Toutes les méthodes

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 renvoie un simple array, car les libellés ne sont pas paginés. color est renvoyé en lecture plutôt qu'abandonné, pour qu'un client puisse afficher un libellé tel que l'utilisateur le voit. type vaut toujours user : il n'y a donc rien sur quoi se brancher. Les ids sont dérivés du nom, si bien que Invoices donne USER_INVOICES.

Paramètres : labels.create et labels.update

namestringobligatoire: Le nom affiché du libellé, dont les espaces sont retirés avant mesure : la limite est donc de 1 à 225 caractères après nettoyage. Des espaces seuls donnent un 422 plutôt qu'une ligne sans nom, avec une pastille de couleur et rien à lire ni à cliquer. `create` refuse en outre dès que la boîte contient déjà 50 libellés utilisateur, avec un 422 `label_limit_reached` nommant `name`.
colorLabelColor: Optionnel sur les deux appels ; l'omettre sur `update` laisse la couleur stockée intacte au lieu de l'effacer. Le corps est strict : une clé approchante comme `colour` donne un 422 plutôt qu'une opération sans effet silencieuse.
color.backgroundColorstringobligatoire: Obligatoire dès que `color` est fourni, et 32 caractères au maximum. Sur la boîte native, c'est la seule moitié conservée : la ligne ne stocke qu'une seule couleur.
color.textColorstringobligatoire: Obligatoire dès que `color` est fourni, et 32 caractères au maximum.

Réponse : Label

object'label': Toujours la string `label`. Une écriture la renvoie aussi, sur un `SavedLabelResource` plutôt que sur ce type.
idstring: L'id propre à la boîte, et ce que prennent `get`, `update` et `delete`. Sur une écriture, il arrive sous la forme `SavedLabelResource.id`, qui est nullable. Quand il vaut null, retrouvez le libellé en listant.
namestring: Ce que voit l'utilisateur, et une chaîne vide plutôt que null quand la boîte renvoie un libellé sans nom. Sur la boîte native, l'id est dérivé de ce nom (`Follow up` devient `USER_FOLLOW_UP`) : un second libellé qui se normalise vers le même id est donc refusé par un 409 `label_name_taken` au lieu d'écraser le premier.
typestring: Toujours `user`. Seuls les libellés utilisateur sont servis ici : les ids des dossiers standard sont filtrés avant la construction de la réponse, et un id système sur `get` donne un 404. La route retombe sur `user` quand la boîte omet le champ, et rien dans `LabelInput` ne le définit.
colorLabelColor | null: Null quand la boîte ne rapporte aucune couleur pour le libellé. Testez les chaînes plutôt que l'object avant d'afficher. Une paire vide n'est pas la même chose qu'une paire absente.
color.backgroundColorstring: L'arrière-plan du libellé tel que la boîte le conserve. Renvoyé plutôt qu'abandonné, pour qu'un client puisse afficher le libellé tel que l'utilisateur le voit dans l'application.
color.textColorstring: La couleur de premier plan. La boîte native n'a pas de colonne pour elle : les lectures renvoient `#ffffff` quoi qu'on ait écrit, si bien qu'un arrière-plan clair revient avec un texte illisible dessus.