Class GmailLabel

GmailLabel

Es una etiqueta creada por el usuario en su cuenta de Gmail.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
addToThread(thread)	GmailLabel	Agrega esta etiqueta al subproceso determinado y fuerza la actualización del subproceso (GmailThread.refresh()).
addToThreads(threads)	GmailLabel	Agrega esta etiqueta a los subprocesos determinados y los obliga a actualizarse.
deleteLabel()	void	Borra esta etiqueta.
getId()	String	Obtiene el ID de esta etiqueta.
getName()	String	Obtiene el nombre de esta etiqueta.
getThreads()	GmailThread[]	Obtiene los subprocesos marcados con esta etiqueta.
getThreads(start, max)	GmailThread[]	Obtiene un rango de subprocesos marcados con esta etiqueta.
getUnreadCount()	Integer	Obtiene la cantidad de subprocesos no leídos etiquetados con esta etiqueta.
removeFromThread(thread)	GmailLabel	Quita esta etiqueta del subproceso determinado y fuerza la actualización del subproceso.
removeFromThreads(threads)	GmailLabel	Quita esta etiqueta de los subprocesos determinados y los obliga a actualizarse.

Documentación detallada

addToThread(thread)

Agrega esta etiqueta al subproceso determinado y fuerza la actualización del subproceso (GmailThread.refresh()).

// label the first thread in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	Es la conversación que se etiquetará.

Volver

GmailLabel: Esta etiqueta, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• removeFromThread(thread)

---

addToThreads(threads)

Agrega esta etiqueta a los subprocesos determinados y los obliga a actualizarse. Puedes agregar etiquetas a un máximo de 100 subprocesos por lote.

// label the first three threads in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de conversaciones que se etiquetarán.

Volver

GmailLabel: Esta etiqueta, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• removeFromThreads(threads)

---

deleteLabel()

Borra esta etiqueta.

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

Arroja

Error: Si no se puede borrar la etiqueta

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• getName()

---

getId()

Obtiene el ID de esta etiqueta.

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

Volver

String: Es el ID de la etiqueta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getName()

Obtiene el nombre de esta etiqueta.

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

Volver

String: Es el nombre de la etiqueta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getThreads()

Obtiene los subprocesos marcados con esta etiqueta.

Estas llamadas fallan cuando el tamaño de todos los subprocesos es demasiado grande para que el sistema lo controle. Cuando el tamaño del subproceso sea desconocido y potencialmente muy grande, usa getThreads(start, max) y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

// Log the subject lines of the threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Volver

GmailThread[]: Es un array de subprocesos marcados con esta etiqueta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getThreads(start, max)

Obtiene un rango de subprocesos marcados con esta etiqueta.

// log the subject lines of up to the first 30 threads with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parámetros

Nombre	Tipo	Descripción
start	Integer	Índice del subproceso inicial.
max	Integer	Es la cantidad máxima de subprocesos que se devolverán.

Volver

GmailThread[]: Es un array de subprocesos marcados con esta etiqueta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getUnreadCount()

Obtiene la cantidad de subprocesos no leídos etiquetados con esta etiqueta.

// log the number of unread threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

Volver

Integer: Es la cantidad de conversaciones etiquetadas no leídas.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

removeFromThread(thread)

Quita esta etiqueta del subproceso determinado y fuerza la actualización del subproceso.

// remove the label MyLabel from the first thread in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	El subproceso no debe tener etiquetas.

Volver

GmailLabel: Esta etiqueta, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• addToThread(thread)

---

removeFromThreads(threads)

Quita esta etiqueta de los subprocesos determinados y los obliga a actualizarse. Puedes quitar etiquetas de hasta 100 conversaciones por lote.

// remove the label MyLabel from the first three threads in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de conversaciones que se deben desetiquetar.

Volver

GmailLabel: Esta etiqueta, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• addToThreads(threads)