Class GmailLabel

GmailLabel

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
addToThread(thread)GmailLabelAgrega esta etiqueta al subproceso determinado y fuerza la actualización del subproceso (GmailThread.refresh()).
addToThreads(threads)GmailLabelAgrega esta etiqueta a los subprocesos dados y fuerza la actualización de los subprocesos.
deleteLabel()voidBorra esta etiqueta.
getName()StringObtiene el nombre de esta etiqueta.
getThreads()GmailThread[]Obtiene los subprocesos que están marcados con esta etiqueta.
getThreads(start, max)GmailThread[]Obtiene un rango de subprocesos marcados con esta etiqueta.
getUnreadCount()IntegerObtiene la cantidad de hilos no leídos etiquetados con esta etiqueta.
removeFromThread(thread)GmailLabelQuita esta etiqueta del subproceso determinado y fuerza la actualización del subproceso.
removeFromThreads(threads)GmailLabelQuita esta etiqueta de los subprocesos determinados y fuerza la actualización de los subprocesos.

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
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.addToThread(firstThread);

Parámetros

NombreTipoDescripción
threadGmailThreadEl subproceso que se etiquetará.

Volver

GmailLabel: Esta etiqueta, para el 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)

Agrega esta etiqueta a los subprocesos dados y fuerza la actualización de los subprocesos. Puedes agregar etiquetas 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

NombreTipoDescripción
threadsGmailThread[]Es un array de subprocesos que se deben etiquetar.

Volver

GmailLabel: Esta etiqueta, para el 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


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()

Obtiene el nombre de esta etiqueta.

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

  • https://mail.google.com/

getThreads()

Obtiene los subprocesos que están marcados con esta etiqueta.

Estas llamadas fallan cuando el tamaño de todos los subprocesos es demasiado grande para que el sistema lo controle. Dónde Se desconoce el tamaño del subproceso y, posiblemente, sea muy grande. Usa getThreads(start, max) y especifica los rangos de 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());
}

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 los permisos 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
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

NombreTipoDescripción
startIntegerEs el índice del subproceso de inicio.
maxIntegerLa cantidad máxima de subprocesos que se mostrará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 los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getUnreadCount()

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

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

Volver

Integer: Es la cantidad de hilos etiquetados no leídos.

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 determinado y fuerza la actualización del subproceso.

// 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

NombreTipoDescripción
threadGmailThreadNo se debe etiquetar el subproceso.

Volver

GmailLabel: Esta etiqueta, para el 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)

Quita esta etiqueta de los subprocesos determinados y fuerza la actualización de los subprocesos. Puedes quitar etiquetas para 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

NombreTipoDescripción
threadsGmailThread[]Array de subprocesos que no se deben etiquetar.

Volver

GmailLabel: Esta etiqueta, para el 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