SDK

Etiquetas

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

Todos los métodos

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 resuelve en un array simple, ya que las etiquetas no se paginan. color se devuelve en las lecturas en lugar de descartarse, para que un cliente pueda renderizar una etiqueta tal como la ve el usuario. type siempre es user, así que no hay nada por lo que ramificar. Los ids se derivan del nombre, así que Invoices es USER_INVOICES.

Parámetros: labels.create y labels.update

namestringobligatorio: El nombre visible de la etiqueta, recortado antes de medirse, de modo que el límite es de 1 a 225 caracteres tras el recorte. Solo espacios en blanco es un 422 en lugar de una fila sin nombre con un punto de color y nada que leer ni pulsar. `create` además rechaza la operación cuando el buzón ya tiene 50 etiquetas de usuario, con un 422 `label_limit_reached` que nombra `name`.
colorLabelColor: Opcional en ambas llamadas, y omitirlo en `update` deja intacto el color almacenado en lugar de borrarlo. El cuerpo es estricto, así que una clave casi correcta como `colour` es un 422 y no una operación silenciosa sin efecto.
color.backgroundColorstringobligatorio: Obligatorio una vez que se indica `color`, y de 32 caracteres como máximo. En el buzón nativo esta es la única mitad que se conserva: la fila guarda un único color.
color.textColorstringobligatorio: Obligatorio una vez que se indica `color`, y de 32 caracteres como máximo.

Respuesta: Label

object'label': Siempre la cadena `label`. Una escritura también lo devuelve, en un `SavedLabelResource` en lugar de en este tipo.
idstring: El id propio del buzón, y lo que aceptan `get`, `update` y `delete`. En una escritura llega como `SavedLabelResource.id`, que admite null. Cuando es null, encuentra la etiqueta listando.
namestring: Lo que ve el usuario, y una cadena vacía en lugar de null cuando el buzón devuelve una etiqueta sin nombre. En el buzón nativo el id se deriva de este nombre (`Follow up` pasa a ser `USER_FOLLOW_UP`), así que una segunda etiqueta que se normalice al mismo id se rechaza con un 409 `label_name_taken` en vez de sobrescribir la primera.
typestring: Siempre `user`. Aquí solo se sirven etiquetas de usuario: los ids de las carpetas estándar se filtran antes de construir la respuesta, y un id de sistema en `get` es un 404. La ruta recurre a `user` cuando el buzón omite el campo, y nada en `LabelInput` lo establece.
colorLabelColor | null: Null cuando el buzón no informa de ningún color para la etiqueta. Comprueba las cadenas y no el objeto antes de renderizar. Un par vacío no es lo mismo que un par ausente.
color.backgroundColorstring: El fondo de la etiqueta tal como lo guarda el buzón. Se devuelve en lugar de descartarse, para que un cliente pueda renderizar la etiqueta como el usuario la ve en la aplicación.
color.textColorstring: El color de primer plano. El buzón nativo no tiene una columna para él: las lecturas devuelven `#ffffff` sea lo que sea que se haya escrito, así que un fondo claro vuelve con texto ilegible encima.