Class GmailApp

Crea un borrador de correo electrónico. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Parámetros

Volver

GmailDraft: Es el borrador de Gmail recién creado.

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

• createDraft(recipient, subject, body, options)

Crea un borrador de correo electrónico con argumentos opcionales. El correo electrónico puede contener texto sin formato o un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados, pero sin incluir los archivos adjuntos) está limitado por cuota.

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parámetros

Parámetros avanzados

Volver

GmailDraft: Es el borrador de Gmail recién creado.

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

• createDraft(recipient, subject, body)

Crea una nueva etiqueta de usuario con el nombre determinado.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Parámetros

Volver

GmailLabel: Es la etiqueta recién creada.

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

Borra la etiqueta especificada.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• createLabel(name)

Obtiene una lista de los correos electrónicos que se configuran como alias para esta cuenta en Gmail.

Puedes enviar un mensaje desde cualquiera de estos alias usando el argumento opcional "from".

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Volver

String[]: Es un array de alias para esta cuenta.

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

• sendEmail(recipient, subject, body, options)

Recupera un borrador de mensaje de correo electrónico por ID.

Úsalo junto con getId() en borradores de Gmail.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

Parámetros

Volver

GmailDraft: Es el borrador con el ID dado.

Arroja

Error: Si no se encuentra ningún borrador con el ID proporcionado

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/

Recupera todos los borradores de mensajes.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Volver

GmailMessage[]: Es un conjunto de borradores de mensajes de Gmail.

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/

Obtiene todos los borradores de mensajes de Gmail.

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Volver

GmailDraft[]: Es un conjunto de mensajes en borrador de Gmail.

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/

Recupera todas las conversaciones de Recibidos, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema pueda manejarlo. Cuando el tamaño del subproceso sea desconocido y posiblemente sea muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Volver

GmailThread[]: Es un array de conversaciones de Gmail en Recibidos.

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/

Recupera un rango de conversaciones de Recibidos, independientemente de las etiquetas.

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parámetros

Volver

GmailThread[]: Es un array de conversaciones de Gmail en Recibidos.

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/

Obtiene la cantidad de conversaciones no leídas en Recibidos.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

Volver

Integer: Es la cantidad de conversaciones en Recibidos que tienen mensajes 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/

Obtiene un mensaje por ID.

Usa esta función junto con getId() en mensajes de Gmail.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

Parámetros

Volver

GmailMessage: Es el mensaje con el ID proporcionado.

Arroja

Error: Si no se encuentra ningún mensaje con el ID proporcionado

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

• getThreadById(id)

Recupera todos los mensajes en el subproceso especificado.

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

Parámetros

Volver

GmailMessage[]: Es el array de mensajes correspondientes a esta conversación.

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

• getMessagesForThreads(threads)

Recupera todos los mensajes en las conversaciones especificadas.

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Parámetros

Volver

GmailMessage[][]: Es un array de arrays de mensajes en el que cada elemento del array externo corresponde a un subproceso y el array interno contiene los mensajes de ese subproceso.

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

• getMessagesForThread(thread)

Recupera todas las conversaciones de Prioritarios, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema pueda manejarlo. Cuando el tamaño del subproceso sea desconocido y posiblemente sea muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

Volver

GmailThread[]: Es un conjunto de conversaciones de Gmail en Prioritarios.

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/

Recupera un rango de conversaciones de Prioritarios, independientemente de las etiquetas.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

Parámetros

Volver

GmailThread[]: Es un conjunto de conversaciones de Gmail en Prioritarios.

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/

Obtiene el número de conversaciones no leídas en Prioritarios.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

Volver

Integer: Es la cantidad de conversaciones de Prioritarios que tienen mensajes 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/

Recupera todas las conversaciones de spam, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema pueda controlarlo. Cuando el tamaño del subproceso sea desconocido y posiblemente sea muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

Volver

GmailThread[]: Es un array de conversaciones de Gmail en la carpeta de spam.

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/

Recupera un rango de conversaciones de spam, independientemente de las etiquetas.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

Parámetros

Volver

GmailThread[]: Es un array de conversaciones de Gmail en la carpeta de spam.

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/

Obtiene la cantidad de conversaciones no leídas que son spam.

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

Volver

Integer: Es la cantidad de conversaciones de spam que tienen mensajes 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/

Recupera todas las conversaciones destacadas, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema pueda manejarlo. Cuando el tamaño del subproceso sea desconocido y posiblemente sea muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

Volver

GmailThread[]: Una variedad de conversaciones destacadas en Gmail

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/

Recupera un rango de conversaciones destacadas, independientemente de las etiquetas.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

Parámetros

Volver

GmailThread[]: Una variedad de conversaciones destacadas en Gmail

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/

Obtiene la cantidad de conversaciones no leídas que están destacadas.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

Volver

Integer: Es la cantidad de conversaciones destacadas que tienen mensajes 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/

Obtiene un subproceso por ID.

Usa esta función junto con getId() en conversaciones de Gmail.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

Parámetros

Volver

GmailThread: Es el subproceso con el ID proporcionado o null si no se encuentra.

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

• getMessageById(id)

Recupera todos los subprocesos de la papelera, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema pueda controlarlo. Cuando el tamaño del subproceso sea desconocido y posiblemente sea muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

Volver

GmailThread[]: Es un array de conversaciones de Gmail en la papelera.

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/

Recupera un rango de subprocesos de la papelera, sin importar las etiquetas.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

Parámetros

Volver

GmailThread[]: Es un array de conversaciones de Gmail en la papelera.

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/

Recupera una etiqueta según su nombre.

var labelObject = GmailApp.getUserLabelByName("myLabel");

Parámetros

Volver

GmailLabel: Es la etiqueta de Gmail con el nombre determinado.

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/

Recupera una lista de las etiquetas creadas por el usuario.

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

Volver

GmailLabel[]: Array de etiquetas creadas por el usuario

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/

Marca este mensaje como leído y fuerza la actualización del mensaje.

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessageUnread(message)

Marca este mensaje como no leído y fuerza la actualización del mensaje.

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessageRead(message)

Marca estos mensajes como leídos y fuerza su actualización.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessagesUnread(messages)

Marca estos mensajes como no leídos y obliga a los mensajes a actualizarse.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessagesRead(messages)

Marca esta conversación como importante y fuerza su actualización.

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadUnimportant(thread)

Marca esta conversación como leída y fuerza su actualización.

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadUnread(thread)

Marca esta conversación como no importante y fuerza su actualización.

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadImportant(thread)

Marca esta conversación como no leída y fuerza su actualización.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadRead(thread)

Marca estos subprocesos como importantes y fuerza su actualización.

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsUnimportant(threads)

Marca estos subprocesos como leídos y fuerza su actualización.

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsUnread(threads)

Marca estas conversaciones como no importantes y fuerza su actualización.

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsImportant(threads)

Marca estas conversaciones como no leídas y fuerza a que se actualicen.

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsRead(threads)

Mueve el mensaje a la papelera y fuerza su actualización.

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parámetros

Volver

GmailApp: Es el servicio de Gmail (útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveMessagesToTrash(messages)

Mueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes.

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parámetros

Volver

GmailApp: Es el servicio de Gmail (útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveMessageToTrash(message)

Mueve esta conversación al archivo y fuerza su actualización.

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

Mueve esta conversación a Recibidos y fuerza su actualización.

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Mueve esta conversación a la carpeta Spam y fuerza la actualización de la conversación.

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

Mueve esta conversación a la papelera y fuerza su actualización.

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Mueve estos subprocesos al archivo y fuerza su actualización.

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

Mueve estas conversaciones a Recibidos y fuerza su actualización.

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Mueve estas conversaciones a la carpeta de spam y obliga a que se actualicen.

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

Mueve estos subprocesos a la papelera y fuerza su actualización.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Vuelve a cargar el mensaje y el estado asociado desde Gmail (es útil en caso de que las etiquetas, el estado de lectura, etc. hayan cambiado).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshMessages(messages)

Vuelve a cargar los mensajes y el estado asociado de Gmail (es útil en caso de que las etiquetas, el estado de lectura, etc. hayan cambiado).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshMessage(message)

Vuelve a cargar el subproceso y el estado asociado desde Gmail (es útil en caso de que las etiquetas, el estado de lectura, etc. hayan cambiado).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshThreads(threads)

Vuelve a cargar los subprocesos y el estado asociado desde Gmail (es útil en caso de que las etiquetas, el estado de lectura, etc. hayan cambiado).

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshThread(thread)

Realiza una búsqueda en Gmail con la consulta dada.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema pueda manejarlo. Cuando el tamaño del subproceso sea desconocido y posiblemente sea muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parámetros

Volver

GmailThread[]: Es un array de conversaciones de Gmail que coinciden con esta búsqueda

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/

Realiza una búsqueda en Gmail con la consulta dada.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parámetros

Volver

GmailThread[]: Es un array de conversaciones de Gmail que coinciden con esta búsqueda

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/

Envía un mensaje de correo electrónico. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• sendEmail(recipient, subject, body, options)

Envía un mensaje de correo electrónico con argumentos opcionales. El correo electrónico puede contener texto sin formato o un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados, pero sin incluir los archivos adjuntos) está limitado por cuota.

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parámetros

Parámetros avanzados

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• sendEmail(recipient, subject, body)

Configura el token de acceso al mensaje actual que habilita la secuencia de comandos para acceder a las propiedades actuales de GmailMessage.

Solo los proyectos del complemento de Google Workspace que usan los permisos actuales de los mensajes de Gmail requieren este método.

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

Parámetros

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/

Destaca este mensaje con una estrella y fuerza su actualización.

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• starMessages(messages)

Destaca con una estrella estos mensajes y los obliga a actualizarse.

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• starMessage(message)

Elimina una estrella de este mensaje y fuerza su actualización.

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• unstarMessages(messages)

Quita las estrellas de estos mensajes y fuerza su actualización.

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parámetros

Volver

GmailApp: Es el servicio de Gmail, que resulta útil 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 los permisos adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• unstarMessage(message)