Se usó la API de Cloud Translation para traducir esta página.

Class GmailLabel

Una etiqueta creada por un usuario en la cuenta de Gmail de un usuario.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addToThread(thread)`	`GmailLabel`	Agrega esta etiqueta al subproceso determinado y fuerza su actualización (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Agrega esta etiqueta a los subprocesos determinados y fuerza la actualización de estos.
`deleteLabel()`	`void`	Borra esta etiqueta.
`getName()`	`String`	Obtiene el nombre de esta etiqueta.
`getThreads()`	`GmailThread[]`	Obtiene las conversaciones que están marcadas con esta etiqueta.
`getThreads(start, max)`	`GmailThread[]`	Obtiene un rango de conversaciones marcadas con esta etiqueta.
`getUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que se etiquetaron con esta etiqueta.
`removeFromThread(thread)`	`GmailLabel`	Quita esta etiqueta del subproceso en cuestión y fuerza su actualización.
`removeFromThreads(threads)`	`GmailLabel`	Quita esta etiqueta de los subprocesos determinados y fuerza la actualización de estos.

Documentación detallada

`addToThread(thread)`

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

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

Parámetros

Nombre	Tipo	Descripción
`thread`	`GmailThread`	El subproceso que se etiquetará.

Devolvedor

GmailLabel: Esta etiqueta se usa para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos 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 fuerza la actualización de estos. Puedes agregar etiquetas para hasta 100 subprocesos por lote.

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

Parámetros

Nombre	Tipo	Descripción
`threads`	`GmailThread[]`	Un array de subprocesos para etiquetar.

Devolvedor

GmailLabel: Esta etiqueta se usa para encadenamiento.

Autorización

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

https://mail.google.com/

Consulta también

removeFromThreads(threads)

`deleteLabel()`

Borra esta etiqueta.

var 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 los permisos adecuados de la API de REST relacionada:

https://mail.google.com/

Consulta también

getName()

`getName()`

Obtiene el nombre de esta etiqueta.

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

Devolvedor

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 los permisos adecuados de la API de REST relacionada:

https://mail.google.com/

`getThreads()`

Obtiene las conversaciones que están marcadas con esta etiqueta.

Las llamadas fallan cuando el tamaño de todos los subprocesos es demasiado grande para que el sistema lo pueda manejar. Si el tamaño del subproceso es desconocido y es posible que sea 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Devolvedor

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 los permisos adecuados de la API de REST relacionada:

https://mail.google.com/

`getThreads(start, max)`

Obtiene un rango de conversaciones marcadas con esta etiqueta.

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

Parámetros

Nombre	Tipo	Descripción
`start`	`Integer`	Es el índice del subproceso de inicio.
`max`	`Integer`	La cantidad máxima de subprocesos que se mostrarán.

Devolvedor

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 los permisos adecuados de la API de REST relacionada:

https://mail.google.com/

`getUnreadCount()`

Obtiene la cantidad de conversaciones no leídas que se etiquetaron con esta etiqueta.

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

Devolvedor

Integer: Indica 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 los permisos adecuados de la API de REST relacionada:

https://mail.google.com/

`removeFromThread(thread)`

Quita esta etiqueta del subproceso en cuestión y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
`thread`	`GmailThread`	No se etiquetará la conversación.

Devolvedor

GmailLabel: Esta etiqueta se usa para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos 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 fuerza la actualización de estos. Puedes quitar etiquetas de hasta 100 subprocesos por lote.

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

Parámetros

Nombre	Tipo	Descripción
`threads`	`GmailThread[]`	Un array de subprocesos que no se etiquetarán.

Devolvedor

GmailLabel: Esta etiqueta se usa para encadenamiento.

Autorización

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

https://mail.google.com/

Consulta también

addToThreads(threads)