Class GmailApp

GmailApp

Proporciona acceso a los hilos, mensajes y etiquetas de Gmail.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
createDraft(recipient, subject, body)	GmailDraft	Crea un borrador de mensaje de correo electrónico.
createDraft(recipient, subject, body, options)	GmailDraft	Crea un borrador de mensaje de correo electrónico con argumentos opcionales.
createLabel(name)	GmailLabel	Crea una etiqueta de usuario nueva con el nombre proporcionado.
deleteLabel(label)	GmailApp	Borra la etiqueta especificada.
getAliases()	String[]	Obtiene una lista de los correos electrónicos configurados como alias para esta cuenta en Gmail.
getDraft(draftId)	GmailDraft	Recupera un borrador de mensaje de correo electrónico por ID.
getDraftMessages()	GmailMessage[]	Recupera todos los mensajes en borrador.
getDrafts()	GmailDraft[]	Obtiene todos los mensajes de borrador de Gmail.
getInboxThreads()	GmailThread[]	Recupera todos los subprocesos de la bandeja de entrada, independientemente de las etiquetas.
getInboxThreads(start, max)	GmailThread[]	Recupera un rango de subprocesos de Recibidos, independientemente de las etiquetas.
getInboxUnreadCount()	Integer	Obtiene la cantidad de hilos no leídos en la carpeta Recibidos.
getMessageById(id)	GmailMessage	Obtiene un mensaje por ID.
getMessagesForThread(thread)	GmailMessage[]	Recupera todos los mensajes de la conversación especificada.
getMessagesForThreads(threads)	GmailMessage[][]	Recupera todos los mensajes de los subprocesos especificados.
getPriorityInboxThreads()	GmailThread[]	Recupera todos los subprocesos de Recibidos prioritarios, independientemente de las etiquetas.
getPriorityInboxThreads(start, max)	GmailThread[]	Recupera un rango de hilos de la bandeja de entrada prioritarios, independientemente de las etiquetas.
getPriorityInboxUnreadCount()	Integer	Obtiene la cantidad de conversaciones no leídas en la carpeta de Recibidos prioritarios.
getSpamThreads()	GmailThread[]	Recupera todos los subprocesos de spam, independientemente de las etiquetas.
getSpamThreads(start, max)	GmailThread[]	Recupera un rango de subprocesos de spam, independientemente de las etiquetas.
getSpamUnreadCount()	Integer	Obtiene la cantidad de hilos no leídos que son spam.
getStarredThreads()	GmailThread[]	Recupera todos los subprocesos destacados, independientemente de las etiquetas.
getStarredThreads(start, max)	GmailThread[]	Recupera un rango de conversaciones destacadas, independientemente de las etiquetas.
getStarredUnreadCount()	Integer	Obtiene la cantidad de conversaciones no leídas que se marcaron con una estrella.
getThreadById(id)	GmailThread|null	Obtiene un subproceso por ID.
getTrashThreads()	GmailThread[]	Recupera todos los subprocesos de la papelera, independientemente de las etiquetas.
getTrashThreads(start, max)	GmailThread[]	Recupera un rango de subprocesos de la papelera, independientemente de las etiquetas.
getUserLabelByName(name)	GmailLabel	Recupera una etiqueta según su nombre.
getUserLabels()	GmailLabel[]	Recupera una lista de las etiquetas creadas por el usuario.
markMessageRead(message)	GmailApp	Marca este mensaje como leído y fuerza su actualización.
markMessageUnread(message)	GmailApp	Marca este mensaje como no leído y fuerza su actualización.
markMessagesRead(messages)	GmailApp	Marca estos mensajes como leídos y fuerza la actualización de los mensajes.
markMessagesUnread(messages)	GmailApp	Marca estos mensajes como no leídos y fuerza la actualización de los mensajes.
markThreadImportant(thread)	GmailApp	Marca este hilo como importante y fuerza su actualización.
markThreadRead(thread)	GmailApp	Marca este hilo como leído y fuerza su actualización.
markThreadUnimportant(thread)	GmailApp	Marca este hilo como no importante y fuerza su actualización.
markThreadUnread(thread)	GmailApp	Marca este hilo como no leído y fuerza su actualización.
markThreadsImportant(threads)	GmailApp	Marca estos subprocesos como importantes y los obliga a actualizarse.
markThreadsRead(threads)	GmailApp	Marca estos hilos como leídos y los obliga a actualizarse.
markThreadsUnimportant(threads)	GmailApp	Marca estos hilos como no importantes y fuerza la actualización de los hilos.
markThreadsUnread(threads)	GmailApp	Marca estos hilos como no leídos y los obliga a actualizarse.
moveMessageToTrash(message)	GmailApp	Mueve el mensaje a la papelera y fuerza la actualización del mensaje.
moveMessagesToTrash(messages)	GmailApp	Mueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes.
moveThreadToArchive(thread)	GmailApp	Mueve este subproceso al archivo y fuerza su actualización.
moveThreadToInbox(thread)	GmailApp	Mueve este subproceso a la bandeja de entrada y fuerza su actualización.
moveThreadToSpam(thread)	GmailApp	Mueve este hilo a spam y fuerza la actualización del hilo.
moveThreadToTrash(thread)	GmailApp	Mueve este subproceso a la papelera y fuerza su actualización.
moveThreadsToArchive(threads)	GmailApp	Mueve estos hilos al archivo y fuerza la actualización de los hilos.
moveThreadsToInbox(threads)	GmailApp	Mueve estos hilos a la bandeja de entrada y los obliga a actualizarse.
moveThreadsToSpam(threads)	GmailApp	Mueve estos hilos a spam y fuerza la actualización de los hilos.
moveThreadsToTrash(threads)	GmailApp	Mueve estos hilos a la papelera y los obliga a actualizarse.
refreshMessage(message)	GmailApp	Vuelve a cargar el mensaje y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
refreshMessages(messages)	GmailApp	Vuelve a cargar los mensajes y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
refreshThread(thread)	GmailApp	Vuelve a cargar el subproceso y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
refreshThreads(threads)	GmailApp	Vuelve a cargar los subprocesos y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
search(query)	GmailThread[]	Busca en Gmail con la consulta proporcionada.
search(query, start, max)	GmailThread[]	Busca en Gmail con la consulta proporcionada.
sendEmail(recipient, subject, body)	GmailApp	Envía un mensaje de correo electrónico.
sendEmail(recipient, subject, body, options)	GmailApp	Envía un mensaje de correo electrónico con argumentos opcionales.
setCurrentMessageAccessToken(accessToken)	void	Establece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades de GmailMessage actuales.
starMessage(message)	GmailApp	Agrega una estrella a este mensaje y lo obliga a actualizarse.
starMessages(messages)	GmailApp	Agrega estrellas a estos mensajes y los obliga a actualizarse.
unstarMessage(message)	GmailApp	Quita la estrella de este mensaje y fuerza su actualización.
unstarMessages(messages)	GmailApp	Quita las estrellas de estos mensajes y los obliga a actualizarse.

Métodos obsoletos

Método	Tipo de datos que se devuelve	Descripción breve
getChatThreads()	GmailThread[]	Obtiene todos los subprocesos de la versión clásica de Google Hangouts y de Google Chat hasta que Google cambie a todos los usuarios de la versión clásica de Hangouts a Chat más adelante este año.
getChatThreads(start, max)	GmailThread[]	Obtiene un rango de subprocesos de la versión clásica de Google Hangouts y de Google Chat hasta que Google cambie a todos los usuarios de la versión clásica de Hangouts a Chat más adelante este año.

Documentación detallada

createDraft(recipient, subject, body)

Crea un borrador de mensaje de correo electrónico. El tamaño del correo electrónico (incluidos los encabezados) está limitado por la cuota.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parámetros

Nombre	Tipo	Descripción
recipient	String	Lista de direcciones de correo electrónico separadas por comas
subject	String	Asunto del correo electrónico
body	String	cuerpo del correo electrónico

Volver

GmailDraft: El GmailDraft 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

Crea un borrador de 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 no los archivos adjuntos) está limitado por la cuota.

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

Parámetros

Nombre	Tipo	Descripción
recipient	String	las direcciones del destinatario
subject	String	la línea de asunto
body	String	El cuerpo del correo electrónico
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

Nombre	Tipo	Descripción
attachments	BlobSource[]	un array de archivos para enviar con el correo electrónico
bcc	String	Una lista de direcciones de correo electrónico separadas por comas para incluir en CCO
cc	String	Una lista de direcciones de correo electrónico separadas por comas para incluir en Cc
from	String	La dirección desde la que se debe enviar el correo electrónico, que debe ser uno de los valores que devuelve getAliases()
htmlBody	String	Si se configura, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento body obligatorio. Puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico.
inlineImages	Object	Un objeto JavaScript que contiene una asignación de la clave de la imagen (String) a los datos de la imagen (BlobSource). Se supone que se usa el parámetro htmlBody y que contiene referencias a estas imágenes en el formato <img src="cid:imageKey" />
name	String	El nombre del remitente del correo electrónico (de forma predeterminada, el nombre del usuario)
replyTo	String	una dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)

Volver

GmailDraft: El GmailDraft 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• createDraft(recipient, subject, body)

---

createLabel(name)

Crea una etiqueta de usuario nueva con el nombre proporcionado.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Parámetros

Nombre	Tipo	Descripción
name	String	Nombre de la etiqueta nueva

Volver

GmailLabel: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• deleteLabel(label)

---

deleteLabel(label)

Borra la etiqueta especificada.

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

Parámetros

Nombre	Tipo	Descripción
label	GmailLabel	La etiqueta que se borrará

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• createLabel(name)

---

getAliases()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

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
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const 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

Nombre	Tipo	Descripción
draftId	String	ID del borrador que se recuperará

Volver

GmailDraft: Es el borrador con el ID determinado.

Arroja

Error: Si no se encuentra ningún borrador con el ID 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getDraftMessages()

Recupera todos los mensajes en borrador.

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

Volver

GmailMessage[]: Es un array 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getDrafts()

Obtiene todos los mensajes de borrador de Gmail.

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

Volver

GmailDraft[]: Es un array de mensajes de 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getInboxThreads()

Recupera todos los subprocesos de la bandeja de entrada, independientemente de las etiquetas.

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

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

Volver

GmailThread[]: Es un array de hilos de Gmail en la carpeta 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getInboxThreads(start, max)

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

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

Parámetros

Nombre	Tipo	Descripción
start	Integer	Índice del primer subproceso que se recuperará
max	Integer	Cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de hilos de Gmail en la carpeta 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getInboxUnreadCount()

Obtiene la cantidad de hilos no leídos en la carpeta Recibidos.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

Volver

Integer: La cantidad de conversaciones en la carpeta de 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getMessageById(id)

Obtiene un mensaje por ID.

Úsalo en conjunto con getId() en los mensajes de Gmail.

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

Parámetros

Nombre	Tipo	Descripción
id	String	ID del mensaje que se recuperará

Volver

GmailMessage: El mensaje con el ID determinado

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

• https://mail.google.com/

Consulta también

• getThreadById(id)

---

getMessagesForThread(thread)

Recupera todos los mensajes de la conversación especificada.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	Es la conversación de mensajes que se recuperará.

Volver

GmailMessage[]: Es un array de mensajes correspondientes a este hilo.

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

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

Recupera todos los mensajes de los subprocesos especificados.

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Son los subprocesos de mensajes que se recuperarán.

Volver

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

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

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

Recupera todos los subprocesos de Recibidos prioritarios, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Cuando el tamaño del subproceso sea desconocido y potencialmente muy grande, usa la llamada "paginada" 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 array de hilos de Gmail en la carpeta 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getPriorityInboxThreads(start, max)

Recupera un rango de hilos de la bandeja de entrada 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

Nombre	Tipo	Descripción
start	Integer	Índice del primer subproceso que se recuperará
max	Integer	Cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de hilos de Gmail en la carpeta 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getPriorityInboxUnreadCount()

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

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

Volver

Integer: Es la cantidad de conversaciones en la carpeta de Recibidos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getSpamThreads()

Recupera todos los subprocesos de spam, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Cuando el tamaño del subproceso sea desconocido y potencialmente muy grande, usa la llamada "paginada" 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 hilos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getSpamThreads(start, max)

Recupera un rango de subprocesos 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

Nombre	Tipo	Descripción
start	Integer	Índice del primer subproceso que se recuperará
max	Integer	Cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de hilos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getSpamUnreadCount()

Obtiene la cantidad de hilos no leídos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getStarredThreads()

Recupera todos los subprocesos destacados, independientemente de las etiquetas.

Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Cuando el tamaño del subproceso sea desconocido y potencialmente muy grande, usa la llamada "paginada" 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[]: Es un array de hilos de Gmail destacados.

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/

---

getStarredThreads(start, max)

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

Nombre	Tipo	Descripción
start	Integer	Índice del primer subproceso que se recuperará
max	Integer	Cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de hilos de Gmail destacados.

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/

---

getStarredUnreadCount()

Obtiene la cantidad de conversaciones no leídas que se marcaron con una estrella.

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

• https://mail.google.com/

---

getThreadById(id)

Obtiene un subproceso por ID.

Úsalo junto con getId() en los hilos 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

Nombre	Tipo	Descripción
id	String	ID del subproceso que se recuperará.

Volver

GmailThread|null: Es el hilo con el ID determinado 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• getMessageById(id)

---

getTrashThreads()

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 lo controle. Cuando el tamaño del subproceso sea desconocido y potencialmente muy grande, usa la llamada "paginada" 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 hilos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getTrashThreads(start, max)

Recupera un rango de subprocesos de la papelera, independientemente de las etiquetas.

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

Parámetros

Nombre	Tipo	Descripción
start	Integer	Índice del primer subproceso que se recuperará
max	Integer	Cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de hilos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getUserLabelByName(name)

Recupera una etiqueta según su nombre.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parámetros

Nombre	Tipo	Descripción
name	String	Nombre de la etiqueta que se recuperará

Volver

GmailLabel: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getUserLabels()

Recupera una lista de las etiquetas creadas por el usuario.

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

Volver

GmailLabel[]: Es un 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

markMessageRead(message)

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

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

Parámetros

Nombre	Tipo	Descripción
message	GmailMessage	El mensaje que se marcará como leído

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessageUnread(message)

---

markMessageUnread(message)

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

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

Parámetros

Nombre	Tipo	Descripción
message	GmailMessage	El mensaje que se marcará como no leído

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessageRead(message)

---

markMessagesRead(messages)

Marca estos mensajes como leídos y fuerza la actualización de los mensajes.

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

Parámetros

Nombre	Tipo	Descripción
messages	GmailMessage[]	Es un array de mensajes para marcar como leídos.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessagesUnread(messages)

---

markMessagesUnread(messages)

Marca estos mensajes como no leídos y fuerza la actualización de los mensajes.

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

Parámetros

Nombre	Tipo	Descripción
messages	GmailMessage[]	Es un array de mensajes para marcar como no leídos.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markMessagesRead(messages)

---

markThreadImportant(thread)

Marca este hilo como importante y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	Es la conversación que se marcará como importante.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadUnimportant(thread)

---

markThreadRead(thread)

Marca este hilo como leído y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	Es el hilo que se marcará como leído.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

Marca este hilo como no importante y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	Es el hilo que se marcará como no importante.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadImportant(thread)

---

markThreadUnread(thread)

Marca este hilo como no leído y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	Es el hilo que se marcará como no leído.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadRead(thread)

---

markThreadsImportant(threads)

Marca estos subprocesos como importantes y los obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de subprocesos para marcar como importantes.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

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

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de conversaciones para marcar como leídas.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

Marca estos hilos como no importantes y fuerza la actualización de los hilos.

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de conversaciones para marcar como no importantes.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

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

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de hilos que se marcarán como no leídos.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• markThreadsRead(threads)

---

moveMessageToTrash(message)

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

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

Parámetros

Nombre	Tipo	Descripción
message	GmailMessage	El mensaje que se enviará a la papelera

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveMessagesToTrash(messages)

---

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parámetros

Nombre	Tipo	Descripción
messages	GmailMessage[]	los mensajes que se enviarán a la papelera

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

Mueve este subproceso al archivo y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	La conversación que se archivará

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadToInbox(thread)

Mueve este subproceso a la bandeja de entrada y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	El hilo que se moverá a Recibidos

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadToSpam(thread)

Mueve este hilo a spam y fuerza la actualización del hilo.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	La conversación que se moverá a spam

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadToTrash(thread)

Mueve este subproceso a la papelera y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
thread	GmailThread	La conversación que se enviará a la papelera

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadsToArchive(threads)

Mueve estos hilos al archivo y fuerza la actualización de los hilos.

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

Parámetros

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

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadsToInbox(threads)

Mueve estos hilos a la bandeja de entrada y los obliga a actualizarse.

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

Parámetros

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

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadsToSpam(threads)

Mueve estos hilos a spam y los obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de conversaciones que se moverán a la carpeta de spam.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

moveThreadsToTrash(threads)

Mueve estos hilos a la papelera y los obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Es un array de conversaciones que se enviarán a la papelera.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

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

---

refreshMessage(message)

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

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

Parámetros

Nombre	Tipo	Descripción
message	GmailMessage	El mensaje que se actualizará

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshMessages(messages)

---

refreshMessages(messages)

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

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

Parámetros

Nombre	Tipo	Descripción
messages	GmailMessage[]	Los mensajes que se actualizarán

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshMessage(message)

---

refreshThread(thread)

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

const 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

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

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshThreads(threads)

---

refreshThreads(threads)

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

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

Parámetros

Nombre	Tipo	Descripción
threads	GmailThread[]	Los hilos que se actualizarán

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• refreshThread(thread)

---

search(query)

Busca en Gmail con la consulta proporcionada.

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

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

Parámetros

Nombre	Tipo	Descripción
query	String	La búsqueda, tal como la escribirías en Gmail

Volver

GmailThread[]: Es un array de hilos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

search(query, start, max)

Busca en Gmail con la consulta proporcionada.

// 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parámetros

Nombre	Tipo	Descripción
query	String	La búsqueda, tal como la escribirías en Gmail
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 hilos 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

sendEmail(recipient, subject, body)

Envía un mensaje de correo electrónico. El tamaño del correo electrónico (incluidos los encabezados) está limitado por la cuota.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parámetros

Nombre	Tipo	Descripción
recipient	String	Lista de direcciones de correo electrónico separadas por comas
subject	String	Asunto del correo electrónico (250 caracteres como máximo)
body	String	cuerpo del correo electrónico

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• sendEmail(recipient, subject, body, options)

---

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 en HTML. El tamaño del correo electrónico (incluidos los encabezados, pero no los archivos adjuntos) está limitado por la cuota.

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

Parámetros

Nombre	Tipo	Descripción
recipient	String	las direcciones del destinatario
subject	String	La línea de asunto (250 caracteres como máximo)
body	String	El cuerpo del correo electrónico
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

Nombre	Tipo	Descripción
attachments	BlobSource[]	un array de archivos para enviar con el correo electrónico
bcc	String	Una lista de direcciones de correo electrónico separadas por comas para incluir en CCO
cc	String	Una lista de direcciones de correo electrónico separadas por comas para incluir en Cc
from	String	La dirección desde la que se debe enviar el correo electrónico, que debe ser uno de los valores que devuelve getAliases()
htmlBody	String	Si se configura, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento body obligatorio. Puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico.
inlineImages	Object	Un objeto JavaScript que contiene una asignación de la clave de la imagen (String) a los datos de la imagen (BlobSource). Se supone que se usa el parámetro htmlBody y que contiene referencias a estas imágenes en el formato <img src="cid:imageKey" />
name	String	El nombre del remitente del correo electrónico (de forma predeterminada, el nombre del usuario)
noReply	Boolean	true si el correo electrónico se debe enviar desde una dirección de correo electrónico genérica de no respuesta para disuadir a los destinatarios de responder a los correos electrónicos; esta opción solo es posible para las cuentas de Google Workspace, no para los usuarios de Gmail
replyTo	String	una dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

Establece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades de GmailMessage actuales.

Solo los proyectos de complementos de Google Workspace que usan alcances de mensajes actuales de Gmail requieren este método.

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

Parámetros

Nombre	Tipo	Descripción
accessToken	String	el token de acceso temporal que se obtiene de un objeto de evento de acción del complemento 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

starMessage(message)

Agrega una estrella a este mensaje y lo obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
message	GmailMessage	el mensaje que se destacará

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• starMessages(messages)

---

starMessages(messages)

Agrega estrellas a estos mensajes y los obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
messages	GmailMessage[]	Es un array de mensajes para destacar.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• starMessage(message)

---

unstarMessage(message)

Quita la estrella de este mensaje y fuerza su actualización.

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

Parámetros

Nombre	Tipo	Descripción
message	GmailMessage	El mensaje que se dejará de destacar

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• unstarMessages(messages)

---

unstarMessages(messages)

Quita las estrellas de estos mensajes y los obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
messages	GmailMessage[]	Es un array de mensajes que se dejarán de destacar.

Volver

GmailApp: 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

Consulta también

• unstarMessage(message)

Métodos obsoletos

getChatThreads()

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Obtiene todos los subprocesos de la versión clásica de Google Hangouts y de Google Chat hasta que Google cambie a todos los usuarios de la versión clásica de Hangouts a Chat más adelante este año. Para obtener más información, consulta Obtén más información sobre el cambio de la versión clásica de Hangouts a Google Chat.

Esta llamada falla cuando el tamaño de todos los subprocesos es demasiado grande para que el sistema lo controle. Cuando el tamaño del subproceso es desconocido y potencialmente muy grande, usa la llamada "paginada" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

Volver

GmailThread[]: Es un array de conversaciones de chat 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 alcances adecuados de la API de REST relacionada:

• https://mail.google.com/

---

getChatThreads(start, max)

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Obtiene un rango de subprocesos de la versión clásica de Google Hangouts y de Google Chat hasta que Google cambie a todos los usuarios de la versión clásica de Hangouts a Chat más adelante este año. Para obtener más información, consulta Obtén más información sobre el cambio de la versión clásica de Hangouts a Google Chat.

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

Parámetros

Nombre	Tipo	Descripción
start	Integer	Índice del primer subproceso que se recuperará
max	Integer	Cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de hilos de Gmail de chat.

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/