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

Class GmailApp

Proporciona acceso a las conversaciones, los mensajes y las etiquetas de Gmail.

Métodos

Método	Tipo de datos que se muestra	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 nueva etiqueta de usuario con el nombre que se indique.
`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 de borrador.
`getDrafts()`	`GmailDraft[]`	Obtiene todos los mensajes de borradores de Gmail.
`getInboxThreads()`	`GmailThread[]`	Recupera todas las conversaciones de Recibidos, independientemente de las etiquetas.
`getInboxThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de Recibidos, independientemente de las etiquetas.
`getInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas 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 las conversaciones especificadas.
`getPriorityInboxThreads()`	`GmailThread[]`	Recupera todos los subprocesos de Recibidos prioritarios, independientemente de las etiquetas.
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de la bandeja de entrada prioritaria, independientemente de las etiquetas.
`getPriorityInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en la bandeja de entrada prioritaria.
`getSpamThreads()`	`GmailThread[]`	Recupera todos los subprocesos de spam, independientemente de las etiquetas.
`getSpamThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de spam, independientemente de las etiquetas.
`getSpamUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que son spam.
`getStarredThreads()`	`GmailThread[]`	Recupera todas las conversaciones destacadas, independientemente de las etiquetas.
`getStarredThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones favoritas, independientemente de las etiquetas.
`getStarredUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que se marcaron como favoritas.
`getThreadById(id)`	`GmailThread`	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 conversaciones de la papelera sin importar 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 lo actualiza de forma forzosa.
`markMessageUnread(message)`	`GmailApp`	Marca este mensaje como no leído y lo actualiza de forma forzosa.
`markMessagesRead(messages)`	`GmailApp`	Marca estos mensajes como leídos y los actualiza de forma forzosa.
`markMessagesUnread(messages)`	`GmailApp`	Marca estos mensajes como no leídos y los actualiza de forma forzosa.
`markThreadImportant(thread)`	`GmailApp`	Marca este subproceso como importante y lo obliga a actualizarse.
`markThreadRead(thread)`	`GmailApp`	Marca este subproceso como leído y lo obliga a actualizarse.
`markThreadUnimportant(thread)`	`GmailApp`	Marca este subproceso como no importante y lo obliga a actualizarse.
`markThreadUnread(thread)`	`GmailApp`	Marca este subproceso como no leído y lo obliga a actualizarse.
`markThreadsImportant(threads)`	`GmailApp`	Marca estos subprocesos como importantes y los obliga a actualizarse.
`markThreadsRead(threads)`	`GmailApp`	Marca estos subprocesos como leídos y los obliga a actualizarse.
`markThreadsUnimportant(threads)`	`GmailApp`	Marca estos subprocesos como no importantes y los obliga a actualizarse.
`markThreadsUnread(threads)`	`GmailApp`	Marca estos subprocesos como no leídos y los obliga a actualizarse.
`moveMessageToTrash(message)`	`GmailApp`	Mueve el mensaje a la papelera y lo actualiza de forma forzosa.
`moveMessagesToTrash(messages)`	`GmailApp`	Mueve los mensajes especificados a la papelera y los obliga a actualizarse.
`moveThreadToArchive(thread)`	`GmailApp`	Mueve este subproceso al archivo y lo fuerza a actualizarse.
`moveThreadToInbox(thread)`	`GmailApp`	Mueve esta conversación a Recibidos y la actualiza de forma forzosa.
`moveThreadToSpam(thread)`	`GmailApp`	Mueve este subproceso a spam y lo fuerza a actualizarse.
`moveThreadToTrash(thread)`	`GmailApp`	Mueve este subproceso a la papelera y lo actualiza de forma forzosa.
`moveThreadsToArchive(threads)`	`GmailApp`	Mueve estos subprocesos al archivo y los obliga a actualizarse.
`moveThreadsToInbox(threads)`	`GmailApp`	Mueve estos subprocesos a Recibidos y los obliga a actualizarse.
`moveThreadsToSpam(threads)`	`GmailApp`	Mueve estos subprocesos a spam y los obliga a actualizarse.
`moveThreadsToTrash(threads)`	`GmailApp`	Mueve estos subprocesos a la papelera y los obliga a actualizarse.
`refreshMessage(message)`	`GmailApp`	Vuelve a cargar el mensaje y el estado asociado desde 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 desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`refreshThread(thread)`	`GmailApp`	Vuelve a cargar la conversación y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`refreshThreads(threads)`	`GmailApp`	Vuelve a cargar las conversaciones y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`search(query)`	`GmailThread[]`	Busca en Gmail con la consulta que se indica.
`search(query, start, max)`	`GmailThread[]`	Busca en Gmail con la consulta que se indica.
`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 `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 una estrella de este mensaje y lo actualiza de forma forzosa.
`unstarMessages(messages)`	`GmailApp`	Quita las estrellas de estos mensajes y los obliga a actualizarse.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
`getChatThreads()`	`GmailThread[]`	Obtén todas las conversaciones clásicas 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 una variedad de conversaciones clásicas 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) tiene una cuota limitada.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    '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: Es el objeto 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 ámbitos o los ámbitos 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 sin incluir los archivos adjuntos) tiene una cuota limitada.

// Create a draft email with a file from Google Drive attached as a PDF.
const 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

Nombre	Tipo	Descripción
`recipient`	`String`	las direcciones del destinatario
`subject`	`String`	el 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 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 establece, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento de cuerpo 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 imagen (`String`) a los datos de imagen (`BlobSource`). Esto supone que se usa el parámetro `htmlBody` y contiene referencias a estas imágenes en el formato `<img src="cid:imageKey" />`
`name`	`String`	el nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
`replyTo`	`String`	Una dirección de correo electrónico que se usará como la dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)

Volver

GmailDraft: Es el objeto 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

Consulta también

createDraft(recipient, subject, body)

`createLabel(name)`

Crea una nueva etiqueta de usuario con el nombre que se indique.

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

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	el nombre de la etiqueta nueva

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 ámbitos o los ámbitos 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 quieres borrar

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 ámbitos o los ámbitos 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 ámbitos o los ámbitos 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 los 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`	el ID del borrador que se recuperará

Volver

GmailDraft: Es el borrador con el ID determinado.

Arroja

Error: Si no se puede encontrar un 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getDraftMessages()`

Recupera todos los mensajes de 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getDrafts()`

Obtiene todos los mensajes de borradores 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getInboxThreads()`

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 controlarlo. 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.

// 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 conversaciones 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getInboxThreads(start, max)`

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
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`	el índice del primer subproceso que se recuperará
`max`	`Integer`	la cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de conversaciones 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getInboxUnreadCount()`

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

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

Volver

Integer: Es la cantidad de conversaciones en la carpeta 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getMessageById(id)`

Obtiene un mensaje por ID.

Úsalo junto 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`	el ID del mensaje que se recuperará

Volver

GmailMessage: Es el mensaje con el ID determinado.

Arroja

Error: Si no se puede encontrar ningún mensaje 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 ámbitos o los ámbitos 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`	el subproceso de mensajes que se recuperarán

Volver

GmailMessage[]: Es un 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

Consulta también

getMessagesForThreads(threads)

`getMessagesForThreads(threads)`

Recupera todos los mensajes de las conversaciones especificadas.

// 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[]`	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 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 ámbitos o los ámbitos 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.

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

Volver

GmailThread[]: Es un array de conversaciones 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getPriorityInboxThreads(start, max)`

Recupera un rango de conversaciones de la bandeja de entrada prioritaria, 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`	el índice del primer subproceso que se recuperará
`max`	`Integer`	la cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de conversaciones 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getPriorityInboxUnreadCount()`

Obtiene la cantidad de conversaciones no leídas en la bandeja de entrada prioritaria.

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

Volver

Integer: Es la cantidad de conversaciones en la carpeta 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getSpamThreads()`

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

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

https://mail.google.com/

`getSpamThreads(start, max)`

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

Nombre	Tipo	Descripción
`start`	`Integer`	el índice del primer subproceso que se recuperará
`max`	`Integer`	la cantidad máxima de subprocesos que se recuperarán

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

https://mail.google.com/

`getSpamUnreadCount()`

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

https://mail.google.com/

`getStarredThreads()`

Recupera todas las conversaciones destacadas, independientemente de las etiquetas.

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

Volver

GmailThread[]: Es un array de conversaciones destacadas de Gmail.

Autorización

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

https://mail.google.com/

`getStarredThreads(start, max)`

Recupera un rango de conversaciones favoritas, 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`	el índice del primer subproceso que se recuperará
`max`	`Integer`	la cantidad máxima de subprocesos que se recuperarán

Volver

GmailThread[]: Es un array de conversaciones destacadas de Gmail.

Autorización

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

https://mail.google.com/

`getStarredUnreadCount()`

Obtiene la cantidad de conversaciones no leídas que se marcaron como favoritas.

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

https://mail.google.com/

`getThreadById(id)`

Obtiene un subproceso por ID.

Úsalo junto con getId() en los subprocesos 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`	Es el ID del subproceso que se recuperará.

Volver

GmailThread: Es el subproceso 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 ámbitos o los ámbitos 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.

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

https://mail.google.com/

`getTrashThreads(start, max)`

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

Nombre	Tipo	Descripción
`start`	`Integer`	el índice del primer subproceso que se recuperará
`max`	`Integer`	la cantidad máxima de subprocesos que se recuperarán

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 ámbitos o los ámbitos 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`	el nombre de la etiqueta que se recuperará

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

https://mail.google.com/

`markMessageRead(message)`

Marca este mensaje como leído y lo actualiza de forma forzosa.

// 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 quieres marcar como leído

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 ámbitos o los ámbitos 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 lo actualiza de forma forzosa.

// 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 quieres marcar como no leído

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 ámbitos o los ámbitos 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 los actualiza de forma forzosa.

// 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[]`	un array de mensajes para marcar como leídos

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 ámbitos o los ámbitos 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 los actualiza de forma forzosa.

// 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[]`	un array de mensajes para marcar como no leídos

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

https://mail.google.com/

Consulta también

markMessagesRead(messages)

`markThreadImportant(thread)`

Marca este subproceso como importante y lo obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
`thread`	`GmailThread`	la conversación que quieres marcar como importante

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

https://mail.google.com/

Consulta también

markThreadUnimportant(thread)

`markThreadRead(thread)`

Marca este subproceso como leído y lo obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
`thread`	`GmailThread`	el subproceso que quieres marcar como leído

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

https://mail.google.com/

Consulta también

markThreadUnread(thread)

`markThreadUnimportant(thread)`

Marca este subproceso como no importante y lo obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
`thread`	`GmailThread`	la conversación que quieres marcar como no importante

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

https://mail.google.com/

Consulta también

markThreadImportant(thread)

`markThreadUnread(thread)`

Marca este subproceso como no leído y lo obliga a actualizarse.

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

Parámetros

Nombre	Tipo	Descripción
`thread`	`GmailThread`	la conversación que quieres marcar como no leída

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 ámbitos o los ámbitos 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[]`	un array de subprocesos para marcar como importantes

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

https://mail.google.com/

Consulta también

markThreadsUnimportant(threads)

`markThreadsRead(threads)`

Marca estos subprocesos 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[]`	Un array de subprocesos para marcar como leídos

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

https://mail.google.com/

Consulta también

markThreadsUnread(threads)

`markThreadsUnimportant(threads)`

Marca estos subprocesos como no importantes y los obliga a actualizarse.

// 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[]`	un array de conversaciones para marcar como no importantes

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

https://mail.google.com/

Consulta también

markThreadsImportant(threads)

`markThreadsUnread(threads)`

Marca estos subprocesos 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[]`	Un array de conversaciones para marcar como no leídas

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 ámbitos o los ámbitos 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 lo actualiza de forma forzosa.

// 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: 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 ámbitos o los ámbitos 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 los obliga a actualizarse.

// 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: 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

Consulta también

moveMessageToTrash(message)

`moveThreadToArchive(thread)`

Mueve este subproceso al archivo y lo fuerza a actualizarse.

// 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: 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`moveThreadToInbox(thread)`

Mueve esta conversación a Recibidos y la actualiza de forma forzosa.

// 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`	la conversación que se moverá a Recibidos

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

https://mail.google.com/

Consulta también

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

`moveThreadToSpam(thread)`

Mueve este subproceso a spam y lo fuerza a actualizarse.

// 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: 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 ámbitos o los ámbitos 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 lo actualiza de forma forzosa.

// 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`	el subproceso que se enviará a la papelera

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

https://mail.google.com/

Consulta también

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

`moveThreadsToArchive(threads)`

Mueve estos subprocesos al archivo y los obliga a actualizarse.

// 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[]`	un array de conversaciones que se archivarán

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

https://mail.google.com/

Consulta también

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

`moveThreadsToInbox(threads)`

Mueve estos subprocesos a Recibidos 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[]`	un array de conversaciones que se moverán a Recibidos

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

https://mail.google.com/

Consulta también

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

`moveThreadsToSpam(threads)`

Mueve estos subprocesos 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[]`	un array de subprocesos que se moverán a spam

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

https://mail.google.com/

Consulta también

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

`moveThreadsToTrash(threads)`

Mueve estos subprocesos 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[]`	un array de conversaciones que se enviarán a la papelera

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 ámbitos o los ámbitos 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 desde 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: 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 ámbitos o los ámbitos 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 desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).

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

https://mail.google.com/

Consulta también

refreshMessage(message)

`refreshThread(thread)`

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

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`	el subproceso que se actualizará

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

https://mail.google.com/

Consulta también

refreshThreads(threads)

`refreshThreads(threads)`

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

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 subprocesos que se actualizarán

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

https://mail.google.com/

Consulta también

refreshThread(thread)

`search(query)`

Busca en Gmail con la consulta que se indica.

// 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 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`search(query, start, max)`

Busca en Gmail con la consulta que se indica.

// 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`	el índice del subproceso inicial
`max`	`Integer`	la cantidad máxima de subprocesos que se mostrarán

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 ámbitos o los ámbitos 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) tiene una cuota limitada.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    '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: 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 ámbitos o los ámbitos 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 HTML. El tamaño del correo electrónico (incluidos los encabezados, pero sin incluir los archivos adjuntos) tiene una cuota limitada.

// Send an email with a file from Google Drive attached as a PDF.
const 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

Nombre	Tipo	Descripción
`recipient`	`String`	las direcciones del destinatario
`subject`	`String`	el 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 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 establece, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento de cuerpo 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 imagen (`String`) a los datos de imagen (`BlobSource`). Esto supone que se usa el parámetro `htmlBody` y contiene referencias a estas imágenes en el formato `<img src="cid:imageKey" />`
`name`	`String`	el nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
`noReply`	`Boolean`	`true` si el correo electrónico se debe enviar desde una dirección genérica de correo electrónico sin respuesta para disuadir a los destinatarios de responder 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 que se usará como la dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)

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 ámbitos o los ámbitos 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 GmailMessage actuales.

Solo los proyectos de complementos de Google Workspace que usan los 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 obtenido 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 ámbitos o los ámbitos 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 quieres destacar

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 ámbitos o los ámbitos 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[]`	un array de mensajes para destacar

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

https://mail.google.com/

Consulta también

starMessage(message)

`unstarMessage(message)`

Quita una estrella de este mensaje y lo actualiza de forma forzosa.

// 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 quieres dejar de destacar

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 ámbitos o los ámbitos 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[]`	un array de mensajes que se dejarán de destacar

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

https://mail.google.com/

Consulta también

unstarMessage(message)

Métodos obsoletos

`getChatThreads()`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén todas las conversaciones clásicas 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

https://mail.google.com/

`getChatThreads(start, max)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene una variedad de conversaciones clásicas 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`	el índice del primer subproceso que se recuperará
`max`	`Integer`	la cantidad máxima de subprocesos que se recuperarán

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

https://mail.google.com/