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 del 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 que se configuraron 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 borradores de mensajes. |
getDrafts() | GmailDraft[] | Obtiene todos los borradores de mensajes de Gmail. |
getInboxThreads() | GmailThread[] | Recupera todas las conversaciones de la bandeja de entrada, independientemente de las etiquetas. |
getInboxThreads(start, max) | GmailThread[] | Recupera un rango de conversaciones de la bandeja de entrada, independientemente de las etiquetas. |
getInboxUnreadCount() | Integer | Obtiene la cantidad de hilos no leídos 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 de los subprocesos especificados. |
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 la cantidad de hilos no leídos en Prioritarios. |
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 hilos no leídos que son spam. |
getStarredThreads() | GmailThread[] | Recupera todos los subprocesos destacados, independientemente de las etiquetas. |
getStarredThreads(start, max) | GmailThread[] | Recupera un rango de subprocesos destacados, independientemente de las etiquetas. |
getStarredUnreadCount() | Integer | Obtiene la cantidad de hilos no leídos que se destacan. |
getThreadById(id) | GmailThread | Obtiene una conversación por ID. |
getTrashThreads() | GmailThread[] | Recupera todos los subprocesos de la papelera, independientemente de las etiquetas. |
getTrashThreads(start, max) | GmailThread[] | Recupera un rango de subprocesos de la papelera, independientemente de las etiquetas. |
getUserLabelByName(name) | GmailLabel | Recupera una etiqueta a partir de su nombre. |
getUserLabels() | GmailLabel[] | Recupera una lista de etiquetas creadas por el usuario. |
markMessageRead(message) | GmailApp | Marca el mensaje como leído y lo fuerza a actualizarse. |
markMessageUnread(message) | GmailApp | Marca este mensaje como no leído y fuerza su actualización. |
markMessagesRead(messages) | GmailApp | Marca estos mensajes como leídos y fuerza su actualización. |
markMessagesUnread(messages) | GmailApp | Marca estos mensajes como no leídos y fuerza su actualización. |
markThreadImportant(thread) | GmailApp | Marca este subproceso como importante y lo fuerza a actualizarse. |
markThreadRead(thread) | GmailApp | Marca este subproceso como leído y lo fuerza a actualizarse. |
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 su actualización. |
markThreadsImportant(threads) | GmailApp | Marca estos subprocesos como importantes y obliga a los subprocesos a actualizarse. |
markThreadsRead(threads) | GmailApp | Marca estos subprocesos como leídos y los fuerza a actualizarse. |
markThreadsUnimportant(threads) | GmailApp | Marca estos subprocesos como no importantes y los obliga a actualizarse. |
markThreadsUnread(threads) | GmailApp | Marca estas conversaciones como no leídas y fuerza su actualización. |
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 la carpeta de 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 la actualización de las conversaciones. |
moveThreadsToSpam(threads) | GmailApp | Mueve estas conversaciones a la carpeta de spam y fuerza la actualización de las conversaciones. |
moveThreadsToTrash(threads) | GmailApp | Mueve estos subprocesos a la papelera y fuerza la actualización de los subprocesos. |
refreshMessage(message) | GmailApp | Vuelve a cargar el mensaje y el estado asociado desde Gmail (útil en caso de que 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 las etiquetas, lean el estado, etc.). |
refreshThread(thread) | GmailApp | Vuelve a cargar la conversación y el estado asociado desde Gmail (útil en caso de que las etiquetas, lean el estado, etc.). |
refreshThreads(threads) | GmailApp | Vuelve a cargar las conversaciones y el estado asociado desde Gmail (útil en caso de que las etiquetas, lean el estado, etc.). |
search(query) | GmailThread[] | Buscar en Gmail con la consulta dada |
search(query, start, max) | GmailThread[] | Buscar en Gmail con la consulta dada |
sendEmail(recipient, subject, body) | GmailApp | Envía un mensaje de correo electrónico. |
sendEmail(recipient, subject, body, options) | GmailApp | Se envía un mensaje de correo electrónico con argumentos opcionales. |
setCurrentMessageAccessToken(accessToken) | void | Configura el mensaje actual
token de acceso que permite que la secuencia de comandos acceda a las propiedades actuales de GmailMessage . |
starMessage(message) | GmailApp | Destaca este mensaje y lo fuerza a actualizarse. |
starMessages(messages) | GmailApp | Destaca estos mensajes y fuerza su actualización. |
unstarMessage(message) | GmailApp | Quita una estrella del mensaje y fuerza su actualización. |
unstarMessages(messages) | GmailApp | Quita las estrellas de estos mensajes y fuerza su actualización. |
Documentación detallada
createDraft(recipient, subject, body)
Crea un borrador del 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 |
Volver
GmailDraft
: Es el GmailDraft recién creado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o 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 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 agregar en Cc |
from | String | la dirección desde la que se debe enviar el correo electrónico, que debe ser una
de los valores que muestra getAliases() |
htmlBody | String | Si está establecido, los dispositivos capaces de renderizar el código HTML lo usarán en su lugar.
del argumento body requerido; puedes agregar un campo inlineImages opcional en HTML
cuerpo si tienes imágenes intercaladas para tu correo electrónico |
inlineImages | Object | un objeto de JavaScript que contiene una asignación de la clave de imagen
(String ) a datos de imágenes (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 para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario) |
Volver
GmailDraft
: Es el GmailDraft recién creado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o 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 |
Volver
GmailLabel
: Es la etiqueta recién creada.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
deleteLabel(label)
Borra la etiqueta especificada.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
label | GmailLabel | la etiqueta que se borrará |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 que se configuraron como alias para esta cuenta en Gmail.
Puedes enviar un mensaje desde cualquiera de estos alias con el prefijo argumento opcional.
// Log the aliases for this Gmail account and send an email as the first one. var me = Session.getActiveUser().getEmail(); var aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]}); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); }
Volver
String[]
: Es un array de alias para esta cuenta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
getDraft(draftId)
Recupera un borrador de mensaje de correo electrónico por ID.
Puedes usarlo 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 que se recuperará |
Volver
GmailDraft
: Es el borrador con el ID proporcionado.
Arroja
Error
: Si no se encuentra ningún borrador con el ID proporcionado, sigue estos pasos:
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);
Volver
GmailMessage[]
: Es un array de borradores de mensajes de Gmail.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getDrafts()
Obtiene todos los borradores de mensajes de Gmail.
var drafts = GmailApp.getDrafts(); for (var i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
Volver
GmailDraft[]
: Es un array 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 la bandeja de entrada, independientemente de las etiquetas.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Si el tamaño del subproceso es desconocido y es posible que sea muy grande, utiliza el parámetro "paged" llamada y especificar los rangos de los subprocesos que se recuperarán en cada llamada.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Volver
GmailThread[]
: Es un 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 la bandeja de entrada, independientemente de las etiquetas.
// Log the subject lines of up to the first 50 emails in your Inbox var threads = GmailApp.getInboxThreads(0, 50); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Integer | el índice del primer subproceso que se recuperará |
max | Integer | la cantidad máxima de subprocesos para recuperar |
Volver
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 hilos no leídos en la bandeja de entrada.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
Volver
Integer
: Es la cantidad de conversaciones de 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.
Puedes usarla junto con getId() en los 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á |
Volver
GmailMessage
: Es el mensaje con el ID proporcionado.
Arroja
Error
: Si no se encuentra ningún mensaje con el ID proporcionado
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
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 cadena de mensajes para recuperar |
Volver
GmailMessage[]
: Es el array de mensajes que corresponde 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 de los subprocesos especificados.
// 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[] | los subprocesos de mensajes para recuperar |
Volver
GmailMessage[][]
: Es un array de mensajes en el que cada elemento del array externo corresponde a un
subproceso, y el array interno contiene los mensajes de ese subproceso
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
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 controle. Si el tamaño del subproceso es desconocido y es posible que sea muy grande, utiliza el parámetro "paged". llamada y especificar los rangos de los subprocesos que se recuperarán en cada llamada.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
Volver
GmailThread[]
: Es un conjunto de conversaciones de Gmail incluidas 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 |
Volver
GmailThread[]
: Es un conjunto de conversaciones de Gmail incluidas 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 la cantidad de hilos no leídos en Prioritarios.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
Volver
Integer
: Es la cantidad de hilos de Prioritarios que tienen mensajes no leídos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getSpamThreads()
Recupera todos los subprocesos de spam, independientemente de las etiquetas.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Si el tamaño del subproceso es desconocido y es posible que sea muy grande, utiliza el parámetro "paged". llamada y especificar los rangos de los subprocesos que se recuperarán en cada llamada.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
Volver
GmailThread[]
: Es un array de conversaciones de Gmail que se encuentran 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, 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 para recuperar |
Volver
GmailThread[]
: Es un array de conversaciones de Gmail que se encuentran 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 hilos no leídos que son spam.
// Unless you actually read stuff in your spam folder, this should be the same as // the number of messages in your spam folder. Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());
Volver
Integer
: Es la cantidad de conversaciones de spam que tienen mensajes no leídos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getStarredThreads()
Recupera todos los subprocesos destacados, independientemente de las etiquetas.
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Si el tamaño del subproceso es desconocido y es posible que sea muy grande, utiliza el parámetro "paged". llamada y especificar los rangos de los subprocesos que se recuperarán en cada llamada.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
Volver
GmailThread[]
: Es un array de 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, 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 para recuperar |
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 alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
getStarredUnreadCount()
Obtiene la cantidad de hilos no leídos que se destacan.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
Volver
Integer
: La cantidad de hilos destacados 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 una conversación por ID.
Puedes usarlo junto con getId() en las 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á. |
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 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 controle. Si el tamaño del subproceso es desconocido y es posible que sea muy grande, utiliza el parámetro "paged". llamada y especificar los rangos de los subprocesos que se recuperarán en cada llamada.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
Volver
GmailThread[]
: Es un array de conversaciones de Gmail que se encuentran 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, independientemente de las etiquetas.
// Will log a number at most 5 Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Integer | el índice del primer subproceso que se recuperará |
max | Integer | la cantidad máxima de subprocesos para recuperar |
Volver
GmailThread[]
: Es un array de conversaciones de Gmail que se encuentran 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 a partir de su nombre.
var 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 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()); }
Volver
GmailLabel[]
: Array de etiquetas creadas por el usuario
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
markMessageRead(message)
Marca el mensaje como leído y lo fuerza 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 para marcarlo como leído |
Volver
GmailApp
: Es el servicio de Gmail, que sirve para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markMessageUnread(message)
Marca este mensaje como no leído y fuerza su actualización.
// 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. |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 marcarlos como leídos |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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ído. |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 este subproceso como importante y lo fuerza a actualizarse.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación para marcarla como importante |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 este subproceso como leído y lo fuerza a actualizarse.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
thread | GmailThread | la conversación para marcarla como leída |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 estos subprocesos como importantes y obliga a los subprocesos a actualizarse.
// 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. |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 los fuerza a actualizarse.
// 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 marcarlos como leídos |
Volver
GmailApp
: Es el servicio de Gmail, que sirve para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
markThreadsUnimportant(threads)
Marca estos subprocesos como no importantes y los obliga a actualizarse.
// 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. |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 su actualización.
// 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 que se enviará a la papelera |
Volver
GmailApp
: Es el servicio de Gmail (útil para el encadenamiento).
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
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 enviarán a la papelera |
Volver
GmailApp
: Es el servicio de Gmail (útil para el encadenamiento).
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
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á |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 que se moverá a Recibidos |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 la carpeta de 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 la carpeta de spam. |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 que se enviará a la papelera |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 la actualización de las conversaciones.
// 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[] | un array de conversaciones que se moverán a Recibidos |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 la carpeta de spam y fuerza la actualización de las conversaciones.
// 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 array de conversaciones que se moverán a Spam |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 estos subprocesos a la papelera y fuerza la actualización de los subprocesos.
// 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 que se enviarán a la papelera |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 desde Gmail (útil en caso de que 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á |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 desde Gmail (útil en caso de que las etiquetas, lean el estado, 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[] | los mensajes que se actualizarán |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 (útil en caso de que las etiquetas, lean el estado, 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á |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 (útil en caso de que las etiquetas, lean el estado, 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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)
Buscar en Gmail con la consulta dada
Esta llamada fallará cuando el tamaño de todos los subprocesos sea demasiado grande para que el sistema lo controle. Si el tamaño del subproceso es desconocido y es posible que sea muy grande, utiliza el parámetro "paged". llamada y especificar 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, 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 alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
search(query, start, max)
Buscar en Gmail con la consulta dada
// Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty array. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
query | String | la búsqueda, tal 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 |
Volver
GmailThread[]
: Es un array de conversaciones de Gmail que coinciden con esta búsqueda.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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)
Se envía un mensaje de correo electrónico con argumentos opcionales. El correo electrónico puede contener texto sin formato o HTML cuerpo. 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 | la línea del 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 agregar en Cc |
from | String | la dirección desde la que se debe enviar el correo electrónico, que debe ser una
de los valores que muestra getAliases() |
htmlBody | String | Si está establecido, los dispositivos capaces de renderizar el código HTML lo usarán en su lugar.
del argumento body requerido; puedes agregar un campo inlineImages opcional en HTML
cuerpo si tienes imágenes intercaladas para tu correo electrónico |
inlineImages | Object | un objeto de JavaScript que contiene una asignación de la clave de imagen
(String ) a datos de imágenes (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 debe enviarse desde un formato genérico
direcciones de correo electrónico sin respuesta para disuadir a los destinatarios de responder los correos electrónicos; esta opción es
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 (predeterminada: la dirección de correo electrónico del usuario) |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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)
Configura el mensaje actual
token de acceso que permite que la secuencia de comandos acceda a las propiedades actuales de GmailMessage
.
Solo los proyectos del complemento de Google Workspace que usan permisos de mensajes actuales 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 y lo fuerza 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 estos mensajes y fuerza su actualización.
// 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 |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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 una estrella del 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 que quieres dejar de destacar |
Volver
GmailApp
: Es el servicio de Gmail, que sirve para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances, o los permisos adecuados de la API de REST relacionada:
-
https://mail.google.com/
Consulta también
unstarMessages(messages)
Quita las estrellas de estos mensajes y fuerza su actualización.
// Unstars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
messages | GmailMessage[] | un array de mensajes para dejar de destacar |
Volver
GmailApp
: Es el servicio de Gmail, que sirve 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/