En este documento, se explica cómo administrar etiquetas en conversaciones y mensajes con la API de Gmail.
Puedes usar etiquetas para identificar, organizar y categorizar mensajes y conversaciones en Gmail. Una etiqueta tiene una relación de muchos a muchos con los mensajes y los hilos: puedes aplicar varias etiquetas a un solo mensaje o hilo, y aplicar una sola etiqueta a varios mensajes o hilos.
Para obtener información sobre cómo crear, obtener, enumerar, actualizar o borrar etiquetas, consulta el recurso labels.
Para administrar etiquetas, debes usar el permiso https://www.googleapis.com/auth/gmail.labels no sensible. Para obtener más información sobre los permisos, consulta Cómo elegir permisos de la API de Gmail.
Tipos de etiquetas
Las etiquetas se presentan en dos variedades: etiquetas SYSTEM reservadas y etiquetas USER personalizadas.
Por lo general, las etiquetas del sistema corresponden a elementos predefinidos en la interfaz web de Gmail, como INBOX. Los nombres de las etiquetas del sistema están reservados. No se puede crear ninguna etiqueta USER con el mismo nombre que una etiqueta SYSTEM. En la siguiente tabla, se enumeran algunas de las etiquetas del sistema de Gmail más comunes:
| Nombre | Se puede aplicar de forma manual | Notas |
|---|---|---|
INBOX |
sí | |
SPAM |
sí | |
TRASH |
sí | |
UNREAD |
sí | |
STARRED |
sí | |
IMPORTANT |
sí | |
SENT |
no | Se aplica automáticamente a los mensajes que cumplen con los siguientes criterios:
|
DRAFT |
no | Se aplica automáticamente a todos los mensajes draft creados con la API de Gmail o la interfaz de Gmail. |
CATEGORY_PERSONAL |
sí | Corresponde a los mensajes que se muestran en la pestaña Personal de la interfaz de Gmail. |
CATEGORY_SOCIAL |
sí | Corresponde a los mensajes que se muestran en la pestaña Social de la interfaz de Gmail. |
CATEGORY_PROMOTIONS |
sí | Corresponde a los mensajes que se muestran en la pestaña Promociones de la interfaz de Gmail. |
CATEGORY_UPDATES |
sí | Corresponde a los mensajes que se muestran en la pestaña Actualizaciones de la interfaz de Gmail. |
CATEGORY_FORUMS |
sí | Corresponde a los mensajes que se muestran en la pestaña Foros de la interfaz de Gmail. |
Administra etiquetas en hilos y mensajes
Las etiquetas solo existen en los mensajes. Si recuperas una lista de etiquetas en un subproceso, obtendrás una lista de las etiquetas que existen en cualquier mensaje del subproceso. Es posible que no exista una etiqueta en todos los mensajes de un hilo.
No puedes aplicar etiquetas a los mensajes en borrador.
Cómo agregar o quitar etiquetas en los subprocesos
Cuando agregas o quitas una etiqueta en un hilo, agregas o quitas la etiqueta especificada en todos los mensajes existentes del hilo.
Si se agregan mensajes a un hilo después de que agregas una etiqueta, los mensajes nuevos no heredan la etiqueta existente asociada al hilo. Para agregar la etiqueta a esos mensajes, vuelve a agregarla al hilo.
Para agregar o quitar las etiquetas asociadas a un subproceso, usa threads.modify.
Cómo agregar o quitar etiquetas en los mensajes
Cuando agregas una etiqueta a un mensaje, esta se agrega al mensaje y se asocia al hilo al que pertenece el mensaje. La etiqueta no se agrega a otros mensajes del hilo.
Si quitas una etiqueta de un mensaje y era el único mensaje del hilo con esa etiqueta, la etiqueta también se quitará del hilo.
Para agregar o quitar las etiquetas aplicadas a un mensaje, usa messages.modify.