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 dado. |
deleteLabel(label) | GmailApp | Borra la etiqueta especificada. |
getAliases() | String[] | Obtiene una lista de los correos electrónicos configurados como alias de esta cuenta en Gmail. |
getDraft(draftId) | GmailDraft | Recupera el borrador de un mensaje de correo electrónico por ID. |
getDraftMessages() | GmailMessage[] | Recupera todos los borradores de mensajes. |
getDrafts() | GmailDraft[] | Obtiene todos los mensajes en borrador 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, sin importar las etiquetas. |
getInboxUnreadCount() | Integer | Obtiene la cantidad de conversaciones no leídas en la bandeja de entrada. |
getMessageById(id) | GmailMessage | Obtiene un mensaje por ID. |
getMessagesForThread(thread) | GmailMessage[] | Recupera todos los mensajes del subproceso especificado. |
getMessagesForThreads(threads) | GmailMessage[][] | Recupera todos los mensajes en las conversaciones especificadas. |
getPriorityInboxThreads() | GmailThread[] | Recupera todas las conversaciones de Prioritarios, independientemente de las etiquetas. |
getPriorityInboxThreads(start, max) | GmailThread[] | Recupera un rango de conversaciones de Prioritarios, independientemente de las etiquetas. |
getPriorityInboxUnreadCount() | Integer | Obtiene el número de conversaciones no leídas en Prioritarios. |
getSpamThreads() | GmailThread[] | Recupera todos los subprocesos de spam, sin importar las etiquetas. |
getSpamThreads(start, max) | GmailThread[] | Recupera un rango de conversaciones de spam sin importar las etiquetas. |
getSpamUnreadCount() | Integer | Obtiene la cantidad de conversaciones no leídas que son spam. |
getStarredThreads() | GmailThread[] | Recupera todos los subprocesos destacados, sin importar las etiquetas. |
getStarredThreads(start, max) | GmailThread[] | Recupera un rango de subprocesos destacados, sin importar las etiquetas. |
getStarredUnreadCount() | Integer | Obtiene la cantidad de conversaciones no leídas que están destacadas. |
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 subprocesos de la papelera sin importar las etiquetas. |
getUserLabelByName(name) | GmailLabel | Recupera una etiqueta según su nombre. |
getUserLabels() | GmailLabel[] | Recupera una lista de etiquetas creadas por el usuario. |
markMessageRead(message) | GmailApp | Marca este mensaje como leído y lo obliga a actualizarse. |
markMessageUnread(message) | GmailApp | Marca este mensaje como no leído y lo fuerza a actualizarse. |
markMessagesRead(messages) | GmailApp | Marca estos mensajes como leídos y fuerza su actualización. |
markMessagesUnread(messages) | GmailApp | Marca estos mensajes como no leídos y fuerza su actualización. |
markThreadImportant(thread) | GmailApp | Marca esta conversación como importante y fuerza su actualización. |
markThreadRead(thread) | GmailApp | Marca esta conversación como leída y fuerza su actualización. |
markThreadUnimportant(thread) | GmailApp | Marca esta conversación como no importante y fuerza su actualización. |
markThreadUnread(thread) | GmailApp | Marca esta conversación como no leída y fuerza a su actualización. |
markThreadsImportant(threads) | GmailApp | Marca estas conversaciones como importantes y fuerza su actualización. |
markThreadsRead(threads) | GmailApp | Marca estos subprocesos como leídos y fuerza su actualización. |
markThreadsUnimportant(threads) | GmailApp | Marca estas conversaciones como no importantes y fuerza su actualización. |
markThreadsUnread(threads) | GmailApp | Marca estas conversaciones como no leídas y fuerza a que se actualicen. |
moveMessageToTrash(message) | GmailApp | Mueve el mensaje a la papelera y fuerza su actualización. |
moveMessagesToTrash(messages) | GmailApp | Mueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes. |
moveThreadToArchive(thread) | GmailApp | Mueve esta conversación al archivo y fuerza su actualización. |
moveThreadToInbox(thread) | GmailApp | Mueve esta conversación a Recibidos y fuerza su actualización. |
moveThreadToSpam(thread) | GmailApp | Mueve esta conversación a Spam y fuerza su actualización. |
moveThreadToTrash(thread) | GmailApp | Mueve esta conversación a la papelera y fuerza su actualización. |
moveThreadsToArchive(threads) | GmailApp | Mueve estos subprocesos al archivo y fuerza su actualización. |
moveThreadsToInbox(threads) | GmailApp | Mueve estas conversaciones a Recibidos y fuerza su actualización. |
moveThreadsToSpam(threads) | GmailApp | Mueve estas conversaciones a Spam y fuerza su actualización. |
moveThreadsToTrash(threads) | GmailApp | Mueve estas conversaciones a la papelera y fuerza su actualización. |
refreshMessage(message) | GmailApp | Vuelve a cargar el mensaje y el estado asociado de Gmail (es ú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 (es ú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 (es ú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 (es útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.). |
search(query) | GmailThread[] | Realiza la búsqueda en Gmail con la búsqueda indicada. |
search(query, start, max) | GmailThread[] | Realiza la búsqueda en Gmail con la búsqueda indicada. |
sendEmail(recipient, subject, body) | GmailApp | Envía un mensaje de correo electrónico. |
sendEmail(recipient, subject, body, options) | GmailApp | Envía un 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 actuales de GmailMessage . |
starMessage(message) | GmailApp | Destaca este mensaje con una estrella y lo obliga a actualizarse. |
starMessages(messages) | GmailApp | Destaca con una estrella 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. |
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. var 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 |
Devolvedor
GmailDraft
: Es el borrador de Gmail recién creado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
createDraft(recipient, subject, body, options)
Crea un borrador de 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. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Parámetros
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 de 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 separada por comas de direcciones de correo electrónico a 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 muestra getAliases() |
htmlBody | String | Si se configura, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento del cuerpo obligatorio. Puedes agregar un campo opcional inlineImages 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 la imagen (BlobSource ); esto 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 (configuración predeterminada: el nombre del usuario) |
replyTo | String | una dirección de correo electrónico para usar como dirección de respuesta predeterminada (configuración predeterminada: la dirección de correo electrónico del usuario) |
Devolvedor
GmailDraft
: Es el borrador de Gmail recién creado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
createLabel(name)
Crea una nueva etiqueta de usuario con el nombre dado.
// 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 |
Devolvedor
GmailLabel
: Es la etiqueta que se creó recientemente.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
deleteLabel(label)
Borra la etiqueta especificada.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
label | GmailLabel | la etiqueta para borrar |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
getAliases()
Obtiene una lista de los correos electrónicos configurados como alias de esta cuenta en Gmail.
Puedes enviar un mensaje desde cualquiera de estos alias usando el argumento opcional "from".
// Log the aliases for this Gmail account and send an email as the first one. var me = Session.getActiveUser().getEmail(); var aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]}); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); }
Devolvedor
String[]
: Es un array de alias para esta cuenta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
getDraft(draftId)
Recupera el borrador de un 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 var draft = GmailApp.getDrafts()[0]; // Get its ID var draftId = draft.getId(); // Now fetch the same draft using that ID. var draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
draftId | String | el ID del borrador para recuperar |
Devolvedor
GmailDraft
: Es el borrador con el ID determinado.
Arroja
Error
: Si no se encuentra ningún borrador con el ID proporcionado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getDraftMessages()
Recupera todos los borradores de mensajes.
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
Devolvedor
GmailMessage[]
: Un conjunto de borradores de mensajes de Gmail
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getDrafts()
Obtiene todos los mensajes en borrador de Gmail.
var drafts = GmailApp.getDrafts(); for (var i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
Devolvedor
GmailDraft[]
: Es un conjunto de mensajes en borrador de Gmail.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
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 lo pueda manejar. Si el tamaño del subproceso es desconocido y es potencialmente muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Devolvedor
GmailThread[]
: Es un conjunto de conversaciones de Gmail en Recibidos
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getInboxThreads(start, max)
Recupera un rango de conversaciones de Recibidos, sin importar las etiquetas.
// Log the subject lines of up to the first 50 emails in your Inbox var threads = GmailApp.getInboxThreads(0, 50); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Integer | el índice del primer subproceso que se recuperará |
max | Integer | la cantidad máxima de subprocesos para recuperar |
Devolvedor
GmailThread[]
: Es un conjunto de conversaciones de Gmail en Recibidos
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getInboxUnreadCount()
Obtiene la cantidad de conversaciones no leídas en la bandeja de entrada.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
Devolvedor
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 alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getMessageById(id)
Obtiene un mensaje por ID.
Úsalo junto con getId() en mensajes de Gmail.
// Get the first message in the first thread of your inbox var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID var messageId = message.getId(); // Now fetch the same message using that ID. var messageById = GmailApp.getMessageById(messageId); // Should always log true as they should be the same message Logger.log(message.getSubject() == messageById.getSubject());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
id | String | el ID del mensaje que se recuperará |
Devolvedor
GmailMessage
: Es 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 los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
getMessagesForThread(thread)
Recupera todos los mensajes del subproceso especificado.
// Log all the subject lines in the first thread of your inbox var thread = GmailApp.getInboxThreads(0, 1)[0]; var messages = GmailApp.getMessagesForThread(thread); for (var i = 0 ; i < messages.length; i++) { Logger.log("subject: " + messages[i].getSubject()); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación de mensajes para recuperar |
Devolvedor
GmailMessage[]
: Es el array de mensajes correspondientes a esta conversación.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
getMessagesForThreads(threads)
Recupera todos los mensajes en las conversaciones especificadas.
// Log the subject lines of all messages in the first two threads of your inbox var thread = GmailApp.getInboxThreads(0, 2); var messages = GmailApp.getMessagesForThreads(thread); for (var i = 0 ; i < messages.length; i++) { for (var j = 0; j < messages[i].length; j++) { Logger.log("subject: " + messages[i][j].getSubject()); } }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | las conversaciones de mensajes para recuperar |
Devolvedor
GmailMessage[][]
: Es un array de arrays de mensajes en el que cada elemento del array externo corresponde a un subproceso, y el interno contiene los mensajes de ese subproceso.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
getPriorityInboxThreads()
Recupera todas las conversaciones de Prioritarios, independientemente de las etiquetas.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo pueda manejar. Si el tamaño del subproceso es desconocido y es potencialmente muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
Devolvedor
GmailThread[]
: Una variedad de conversaciones de Gmail en Prioritarios
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getPriorityInboxThreads(start, max)
Recupera un rango de conversaciones de Prioritarios, independientemente de las etiquetas.
// Will log some number 2 or less Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads(0, 2).length);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Integer | el índice del primer subproceso que se recuperará |
max | Integer | la cantidad máxima de subprocesos para recuperar |
Devolvedor
GmailThread[]
: Una variedad de conversaciones de Gmail en Prioritarios
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
Obtiene el número de conversaciones no leídas en Prioritarios.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
Devolvedor
Integer
: Es la cantidad de conversaciones en Prioritarios que tienen mensajes no leídos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getSpamThreads()
Recupera todos los subprocesos de spam, sin importar las etiquetas.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo pueda manejar. Si el tamaño del subproceso es desconocido y es potencialmente muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
Devolvedor
GmailThread[]
: Es un conjunto de conversaciones de Gmail en la carpeta de spam.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getSpamThreads(start, max)
Recupera un rango de conversaciones de spam sin importar 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 para recuperar |
Devolvedor
GmailThread[]
: Es un conjunto de conversaciones de Gmail en la carpeta de spam.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
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());
Devolvedor
Integer
: Es la cantidad de conversaciones de spam que tienen mensajes no leídos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getStarredThreads()
Recupera todos los subprocesos destacados, sin importar las etiquetas.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo pueda manejar. Si el tamaño del subproceso es desconocido y es potencialmente muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
Devolvedor
GmailThread[]
: Una variedad 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 alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getStarredThreads(start, max)
Recupera un rango de subprocesos destacados, sin importar 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 para recuperar |
Devolvedor
GmailThread[]
: Una variedad 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 alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getStarredUnreadCount()
Obtiene la cantidad de conversaciones no leídas que están destacadas.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
Devolvedor
Integer
: Es la cantidad de conversaciones destacadas que tienen mensajes no leídos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getThreadById(id)
Obtiene un subproceso por ID.
Úsalo junto con getId() en conversaciones de Gmail.
// Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0,1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
id | String | El ID del subproceso que se recuperará. |
Devolvedor
GmailThread
: Es el subproceso con el ID especificado o null
si no se encuentra.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
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 pueda manejar. Si el tamaño del subproceso es desconocido y es potencialmente muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
Devolvedor
GmailThread[]
: Un conjunto de conversaciones de Gmail en la papelera
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getTrashThreads(start, max)
Recupera un rango de subprocesos de la papelera sin importar las etiquetas.
// Will log a number at most 5 Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Integer | el índice del primer subproceso que se recuperará |
max | Integer | la cantidad máxima de subprocesos para recuperar |
Devolvedor
GmailThread[]
: Un conjunto de conversaciones de Gmail en la papelera
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getUserLabelByName(name)
Recupera una etiqueta según su nombre.
var labelObject = GmailApp.getUserLabelByName("myLabel");
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | el nombre de la etiqueta para recuperar |
Devolvedor
GmailLabel
: Es la etiqueta de Gmail con el nombre determinado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getUserLabels()
Recupera una lista de etiquetas creadas por el usuario.
// Logs all of the names of your labels var labels = GmailApp.getUserLabels(); for (var i = 0; i < labels.length; i++) { Logger.log("label: " + labels[i].getName()); }
Devolvedor
GmailLabel[]
: Array de etiquetas creadas por el usuario
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
markMessageRead(message)
Marca este mensaje como leído y lo obliga a actualizarse.
// Mark the first message in the first thread of your inbox as read var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
message | GmailMessage | el mensaje que se marcará como leído |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markMessageUnread(message)
Marca este mensaje como no leído y lo fuerza a actualizarse.
// Mark the first message in the first thread of your inbox as unread var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
message | GmailMessage | el mensaje para marcarlo como no leído. |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markMessagesRead(messages)
Marca estos mensajes como leídos y fuerza su actualización.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | un array de mensajes para marcar como leídos |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markMessagesUnread(messages)
Marca estos mensajes como no leídos y fuerza su actualización.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(thread.getMessages());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | un array de mensajes para marcar como no leídos |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadImportant(thread)
Marca esta conversación como importante y fuerza su actualización.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | en la conversación para marcarla como importante. |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadRead(thread)
Marca esta conversación como leída y fuerza su actualización.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | conversación para marcarla como leída. |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadUnimportant(thread)
Marca esta conversación como no importante y fuerza su actualización.
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación para marcarla como no importante. |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadUnread(thread)
Marca esta conversación como no leída y fuerza a su actualización.
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación para marcarla como no leída. |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadsImportant(threads)
Marca estas conversaciones como importantes y fuerza su actualización.
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un array de subprocesos para marcar como importantes |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadsRead(threads)
Marca estos subprocesos como leídos y fuerza su actualización.
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un array de subprocesos para marcar como leídos |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadsUnimportant(threads)
Marca estas conversaciones como no importantes y fuerza su actualización.
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un array de subprocesos para marcar como no importantes |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadsUnread(threads)
Marca estas conversaciones como no leídas y fuerza a que se actualicen.
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un array de conversaciones para marcar como no leídas |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveMessageToTrash(message)
Mueve el mensaje a la papelera y fuerza su actualización.
// Move the first message in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
message | GmailMessage | el mensaje a enviar a la papelera |
Devolvedor
GmailApp
: Es el servicio de Gmail (útil para encadenar).
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveMessagesToTrash(messages)
Mueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes.
// Move first two messages in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var messages = firstThread.getMessages(); var toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | los mensajes que se envíen a la papelera |
Devolvedor
GmailApp
: Es el servicio de Gmail (útil para encadenar).
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadToArchive(thread)
Mueve esta conversación al archivo y fuerza su actualización.
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación que se archivará |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadToInbox(thread)
Mueve esta conversación a Recibidos y fuerza su actualización.
// Find a thread not already in your inbox var thread = GmailApp.search("-in:inbox")[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación se moverá a Recibidos |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadToSpam(thread)
Mueve esta conversación a Spam y fuerza su actualización.
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación se moverá a Spam |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadToTrash(thread)
Mueve esta conversación a la papelera y fuerza su actualización.
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación a la papelera |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadsToArchive(threads)
Mueve estos subprocesos al archivo y fuerza su actualización.
// Move first two threads in your inbox to the archive var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToArchive(firstTwoThreads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un array de subprocesos para archivar |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadsToInbox(threads)
Mueve estas conversaciones a Recibidos y fuerza su actualización.
// Find two threads not already in your inbox var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | una matriz de conversaciones que se moverán a Recibidos |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadsToSpam(threads)
Mueve estas conversaciones a Spam y fuerza su actualización.
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un conjunto de conversaciones que se moverán a la carpeta Spam |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
moveThreadsToTrash(threads)
Mueve estas conversaciones a la papelera y fuerza su actualización.
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
threads | GmailThread[] | un array de subprocesos a la papelera |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
refreshMessage(message)
Vuelve a cargar el mensaje y el estado asociado de Gmail (es útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; // ...Do something that may take a while here.... GmailApp.refreshMessage(firstMessage); // ...Do more stuff with firstMessage...
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
message | GmailMessage | el mensaje que se actualizará |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
refreshMessages(messages)
Vuelve a cargar los mensajes y el estado asociado de Gmail (es útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 2); // ...Do something that may take a while here.... GmailApp.refreshMessages(coupleOfMessages); // ...Do more stuff with coupleOfMessages...
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | que los mensajes se actualicen |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
refreshThread(thread)
Vuelve a cargar la conversación y el estado asociado desde Gmail (es útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ...
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación que se actualizará. |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
refreshThreads(threads)
Vuelve a cargar las conversaciones y el estado asociado desde Gmail (es útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
var 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 |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
search(query)
Realiza la búsqueda en Gmail con la búsqueda indicada.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo pueda manejar. Si el tamaño del subproceso es desconocido y es potencialmente muy grande, usa la llamada "paged" y especifica los rangos de los subprocesos que se recuperarán en cada llamada.
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
query | String | la búsqueda, como la escribirías en Gmail |
Devolvedor
GmailThread[]
: Es un array de conversaciones de Gmail que coinciden con esta búsqueda
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
search(query, start, max)
Realiza la búsqueda en Gmail con la búsqueda indicada.
// Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty array. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
query | String | la búsqueda, como la escribirías en Gmail |
start | Integer | el índice del subproceso de inicio |
max | Integer | la cantidad máxima de subprocesos que se mostrarán |
Devolvedor
GmailThread[]
: Es un array de conversaciones de Gmail que coinciden con esta búsqueda
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
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. var 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 |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
sendEmail(recipient, subject, body, options)
Envía un 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. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Parámetros
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 de 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 separada por comas de direcciones de correo electrónico a 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 muestra getAliases() |
htmlBody | String | Si se configura, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento del cuerpo obligatorio. Puedes agregar un campo opcional inlineImages 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 la imagen (BlobSource ); esto 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 (configuración predeterminada: el nombre del usuario) |
noReply | Boolean | true si el correo electrónico se debe enviar desde una dirección genérica que no recibe respuestas, a fin de evitar que los destinatarios respondan los correos electrónicos. Esta opción solo es posible para cuentas de Google Workspace, no para usuarios de Gmail. |
replyTo | String | una dirección de correo electrónico para usar como dirección de respuesta predeterminada (configuración predeterminada: la dirección de correo electrónico del usuario) |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
setCurrentMessageAccessToken(accessToken)
Establece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades actuales de GmailMessage
.
Solo los proyectos del complemento de Google Workspace que usan los permisos actuales de los mensajes de Gmail requieren este método.
function handleAddonActionEvent(e) { var accessToken = e.messageMetadata.accessToken; var messageId = e.messageMetadata.messageId; GmailApp.setCurrentMessageAccessToken(accessToken); var mailMessage = GmailApp.getMessageById(messageId); // Do something with mailMessage }
Parámetros
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 alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
starMessage(message)
Destaca este mensaje con una estrella y lo obliga a actualizarse.
// Stars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.starMessage(message);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
message | GmailMessage | el mensaje para destacar |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
starMessages(messages)
Destaca con una estrella estos mensajes y los obliga a actualizarse.
// Stars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | un array de mensajes para destacar |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
unstarMessage(message)
Quita la estrella de este mensaje y fuerza su actualización.
// Unstars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
message | GmailMessage | el mensaje para dejar de destacar |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
unstarMessages(messages)
Quita las estrellas de estos mensajes y los obliga a actualizarse.
// Unstars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | un array de mensajes para dejar de destacar |
Devolvedor
GmailApp
: Es el servicio de Gmail, que es útil para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/