Python
Etiquetas
`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` y `delete`.
Todos los métodos
from openemail import openemail page = openemail.labels.list(limit=50)every = openemail.labels.list_all()colors = openemail.labels.list_colors() created = openemail.labels.create({ 'name': 'Invoices', 'color': {'backgroundColor': 'gradient:sunset'},}) openemail.labels.update(created['id'], {'name': 'Invoices 2027'})openemail.labels.update(created['id'], {'color': {'backgroundColor': '#3B82F6'}})openemail.labels.delete(created['id'])list devuelve una Page de etiquetas ordenadas por nombre, y list_all e iterate recorren todas las páginas. Cada etiqueta lleva su color, threadCount y cuándo se creó y se cambió por última vez. list_colors devuelve la paleta que ofrece la app, catorce sólidos y siete degradados, como una lista simple. type es siempre user. El id sale del nombre con el que se creó la etiqueta, así que Invoices es USER_INVOICES, y no cambia nunca.
Una etiqueta pertenece al espacio de trabajo, así que renombrarla, recolorearla o eliminarla la cambia para todos los miembros y todas las claves. threads.update pone y quita etiquetas de una conversación, y threads.list(folder='USER_INVOICES') lista todas las conversaciones que llevan una.
Parámetros: labels.create y labels.update
namestr- El nombre visible de la etiqueta, recortado antes de medirse, así que el límite es de 1 a 225 caracteres tras el recorte. Obligatorio en `create` y opcional en `update`, donde omitirlo conserva el nombre. Solo espacios es un 422. Un nombre que ya tiene otra etiqueta, comparado sin distinguir mayúsculas, es un 409 `label_name_taken`, y `create` rechaza cuando el espacio de trabajo ya tiene 50 etiquetas, con un 422 `label_limit_reached`.
colorLabelColorInput | None- Opcional en ambas llamadas. Omitirlo en `update` conserva el color almacenado, y `None` lo borra. El cuerpo es estricto, así que una clave casi correcta como `colour` es un 422 y no una operación silenciosa sin efecto.
color.backgroundColorstrobligatorio- Un color hexadecimal (`#RGB`, `#RGBA`, `#RRGGBB` o `#RRGGBBAA`, guardado en mayúsculas) o un token de degradado: `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` o `gradient:midnight`. Una cadena vacía significa sin color, y cualquier otra cosa es un 422 `invalid_parameter`.
color.textColorstr- Se acepta y se ignora. La tinta se calcula a partir de `backgroundColor`, igual que en la app.
Respuesta: LabelResource
objectLiteral['label']- Siempre la cadena `label`. `create` y `update` devuelven este mismo tipo, leído tal como se guarda.
idstr- El id de la etiqueta, y lo que aceptan `get`, `update`, `delete` y `threads.update`. No cambia nunca, ni siquiera tras un cambio de nombre.
namestr- Lo que ve el usuario.
typestr- Siempre `user`. Aquí nunca se sirven etiquetas de sistema, y un id de sistema en `get` es un 404.
colorLabelColor | None- `None` cuando la etiqueta no tiene color.
color.backgroundColorstr- El color almacenado: un valor hexadecimal o un token de degradado. `list_colors` da los dos extremos de un degradado.
color.textColorstr- La tinta que la app dibuja sobre el color, `#18181B` o `#FFFFFF`, calculada en el servidor en lugar de almacenada.
threadCountint- Cuántas conversaciones llevan la etiqueta ahora. Para una clave limitada a ciertas direcciones, solo cuentan las conversaciones entregadas a ellas.
createdAtstr | None- Cuándo se creó la etiqueta, en ISO 8601, o `None` en una etiqueta creada antes de que se registraran estas fechas.
updatedAtstr | None- El último cambio de nombre o de color, en ISO 8601, o `None` en una etiqueta creada antes de que se registraran estas fechas.
Respuesta: LabelColorResource
kindLiteral['solid', 'gradient']- Si la muestra es un solo color o un degradado.
namestr- El nombre de la muestra, como `red` o `sunset`.
valuestr- Lo que hay que enviar como `color.backgroundColor` para usar esta muestra.
solidstr- Un único hexadecimal para los sitios donde no se puede dibujar un degradado. Igual que `value` en un sólido.
fromstr | None- Dónde empieza un degradado, dibujado a 135 grados. `None` en un sólido.
tostr | None- Dónde termina un degradado. `None` en un sólido.
textColorstr- La tinta que la app dibuja sobre esta muestra.