SDK

Etiquetes

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

Tots els mètodes

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 es resol en un array simple, ja que les etiquetes no es paginen. color es retorna a les lectures en lloc de descartar-se, perquè un client pugui pintar una etiqueta tal com la veu l'usuari. type sempre és user, de manera que no hi ha res on bifurcar. Els ids deriven del nom, així Invoices és USER_INVOICES.

Paràmetres: labels.create i labels.update

namestringobligatori: El nom visible de l'etiqueta, retallat abans de mesurar-lo, de manera que el límit és d'1 a 225 caràcters un cop retallat. Només espais en blanc és un 422 i no pas una fila sense nom amb un punt de color i res per llegir ni clicar. A més, `create` es nega un cop la bústia ja té 50 etiquetes d'usuari, amb un 422 `label_limit_reached` que anomena `name`.
colorLabelColor: Opcional a totes dues crides, i ometre'l a `update` deixa el color emmagatzemat intacte en lloc d'esborrar-lo. El cos és estricte, de manera que una clau gairebé encertada com ara `colour` és un 422 i no pas una operació nul·la silenciosa.
color.backgroundColorstringobligatori: Obligatori un cop es dona `color`, i com a màxim 32 caràcters. A la bústia nativa aquesta és l'única meitat que es conserva: la fila desa un sol color.
color.textColorstringobligatori: Obligatori un cop es dona `color`, i com a màxim 32 caràcters.

Resposta: Label

object'label': Sempre l'string `label`. Una escriptura també el retorna, en un `SavedLabelResource` i no pas en aquest tipus.
idstring: L'id propi de la bústia, i el que prenen `get`, `update` i `delete`. En una escriptura arriba com a `SavedLabelResource.id`, que admet null. Quan és null, troba l'etiqueta llistant.
namestring: El que veu l'usuari, i un string buit en lloc de null quan la bústia retorna una etiqueta sense nom. A la bústia nativa l'id deriva d'aquest nom (`Follow up` esdevé `USER_FOLLOW_UP`), de manera que una segona etiqueta que es normalitzi al mateix id es rebutja amb un 409 `label_name_taken` en lloc de sobreescriure la primera.
typestring: Sempre `user`. Aquí només se serveixen etiquetes d'usuari: els ids de carpeta estàndard es filtren abans de construir la resposta, i un id de sistema a `get` és un 404. La ruta recorre a `user` quan la bústia omet el camp, i res de `LabelInput` no l'estableix.
colorLabelColor | null: Null quan la bústia no informa de cap color per a l'etiqueta. Comprova els strings i no pas l'objecte abans de pintar. Un parell buit no és el mateix que un d'absent.
color.backgroundColorstring: El fons de l'etiqueta tal com el desa la bústia. Es retorna en lloc de descartar-se, perquè un client pugui pintar l'etiqueta tal com la veu l'usuari a l'aplicació.
color.textColorstring: El color de primer pla. La bústia nativa no en té columna: les lectures retornen `#ffffff` s'hi hagi escrit el que s'hi hagi escrit, de manera que un fons clar torna amb text il·legible al damunt.