Class GmailMessage

GmailMensaje

Un mensaje en la cuenta de Gmail de un usuario

Métodos

Método	Tipo de datos que se muestra	Descripción breve
createDraftReply(body)	GmailDraft	Crea un borrador de mensaje para responder al remitente de este mensaje con la dirección de respuesta.
createDraftReply(body, options)	GmailDraft	Crea un borrador de mensaje que responde al remitente de este mensaje con la dirección de respuesta, con argumentos opcionales.
createDraftReplyAll(body)	GmailDraft	Crea un borrador de mensaje para responder al remitente con la dirección de respuesta y todos los destinatarios de este mensaje.
createDraftReplyAll(body, options)	GmailDraft	Crea un borrador de mensaje que responde al remitente de este mensaje con la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
forward(recipient)	GmailMessage	Reenvía este mensaje a destinatarios nuevos.
forward(recipient, options)	GmailMessage	Reenvía este mensaje a destinatarios nuevos con argumentos opcionales.
getAttachments()	GmailAttachment[]	Obtiene todos los archivos adjuntos de este mensaje.
getAttachments(options)	GmailAttachment[]	Obtiene todos los archivos adjuntos de este mensaje.
getBcc()	String	Obtiene los destinatarios separados por comas en el campo Cco de este mensaje.
getBody()	String	Obtiene el contenido HTML del cuerpo de este mensaje.
getCc()	String	Obtiene los destinatarios separados por comas que aparecen en el campo Cc de este mensaje.
getDate()	Date	Obtiene la fecha y la hora de este mensaje.
getFrom()	String	Obtiene el remitente de este mensaje.
getHeader(name)	String	Obtiene el valor de un encabezado RFC 2822 según el nombre del encabezado.
getId()	String	Obtiene el ID de este mensaje.
getPlainBody()	String	Obtiene el contenido del cuerpo de este mensaje sin formato HTML.
getRawContent()	String	Obtiene el contenido sin procesar de este mensaje.
getReplyTo()	String	Obtiene la dirección de respuesta de este mensaje (por lo general, el remitente).
getSubject()	String	Obtiene el asunto de este mensaje.
getThread()	GmailThread	Obtiene la conversación que contiene este mensaje.
getTo()	String	Obtiene los destinatarios de este mensaje separados por comas.
isDraft()	Boolean	Indica si este mensaje es un borrador.
isInChats()	Boolean	Obtiene si este mensaje es un chat.
isInInbox()	Boolean	Obtiene si este mensaje está en la carpeta Recibidos.
isInPriorityInbox()	Boolean	Muestra true si este mensaje está en la carpeta Recibidos prioritarios; muestra false en caso contrario.
isInTrash()	Boolean	Obtiene si este mensaje está en la papelera.
isStarred()	Boolean	Obtiene si este mensaje está destacado.
isUnread()	Boolean	Indica si este mensaje está leído.
markRead()	GmailMessage	Marca el mensaje como leído.
markUnread()	GmailMessage	Marca el mensaje como no leído.
moveToTrash()	GmailMessage	Mueve el mensaje a la papelera.
refresh()	GmailMessage	Vuelve a cargar este mensaje y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
reply(body)	GmailMessage	Responde al remitente de este mensaje con la dirección de respuesta.
reply(body, options)	GmailMessage	Responde al remitente de este mensaje con la dirección de respuesta, con argumentos opcionales.
replyAll(body)	GmailMessage	Responde al remitente con la dirección de respuesta y a todos los destinatarios de este mensaje.
replyAll(body, options)	GmailMessage	Responde al remitente de este mensaje con la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
star()	GmailMessage	Destaca el mensaje.
unstar()	GmailMessage	Deja de destacar el mensaje.

Documentación detallada

createDraftReply(body)

Crea un borrador de mensaje para responder al remitente de este mensaje con la dirección de respuesta. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.

Volver

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

Autorización

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

• https://mail.google.com/

Consulta también

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReply(body, options)

Crea un borrador de mensaje que responde al remitente de este mensaje con la dirección de respuesta, con argumentos opcionales.

El correo electrónico puede contener texto sin formato y un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

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

Volver

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

Autorización

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

• https://mail.google.com/

Consulta también

• reply(body, options)
• createDraftReply(body)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body)

Crea un borrador de mensaje para responder al remitente con la dirección de respuesta y todos los destinatarios de este mensaje. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.

Volver

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

Autorización

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

• https://mail.google.com/

Consulta también

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body, options)

Crea un borrador de mensaje que responde al remitente de este mensaje con la dirección de respuesta y todos los destinatarios, con argumentos opcionales.

El correo electrónico puede contener texto sin formato y un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

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

Volver

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

Autorización

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

• https://mail.google.com/

Consulta también

• replyAll(body, options)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)

---

forward(recipient)

Reenvía este mensaje a destinatarios nuevos. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('[e-mail],[e-mail]');

Parámetros

Nombre	Tipo	Descripción
recipient	String	Una lista de direcciones de correo electrónico separadas por comas.

Volver

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

• https://mail.google.com/

Consulta también

• forward(recipient, options)

---

forward(recipient, options)

Reenvía este mensaje a destinatarios nuevos con argumentos opcionales.

El correo electrónico puede contener texto sin formato y un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('[e-mail],[e-mail]', {
  cc: '[e-mail]',
  bcc: '[e-mail],[e-mail]',
});

Parámetros

Nombre	Tipo	Descripción
recipient	String	Una lista de direcciones de correo electrónico separadas por comas.
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

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

Volver

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

• https://mail.google.com/

Consulta también

• forward(recipient)

---

getAttachments()

Obtiene todos los archivos adjuntos de este mensaje.

Volver

GmailAttachment[]: Es un array de archivos adjuntos de Blob para este mensaje.

Autorización

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

• https://mail.google.com/

---

getAttachments(options)

Obtiene todos los archivos adjuntos de este mensaje.

Parámetros

Nombre	Tipo	Descripción
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

Nombre	Tipo	Descripción
includeInlineImages	Boolean	true si el array de archivos adjuntos de Blob que se muestra debe incluir imágenes intercaladas (el valor predeterminado es true).
includeAttachments	Boolean	true si el array de archivos adjuntos de Blob que se muestra debe incluir archivos adjuntos normales (no intercalados) (el valor predeterminado es true).

Volver

GmailAttachment[]: Es un array de archivos adjuntos de Blob para este mensaje.

Autorización

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

• https://mail.google.com/

---

getBcc()

Obtiene los destinatarios separados por comas en el campo Cco de este mensaje.

De forma predeterminada, este campo está vacío para todos los mensajes recibidos.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

Volver

String: Los destinatarios separados por comas que aparecen en el campo Cco de este mensaje.

Autorización

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

• https://mail.google.com/

Consulta también

• getTo()

---

getBody()

Obtiene el contenido HTML del cuerpo de este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

Volver

String: Es el contenido del cuerpo de este mensaje.

Autorización

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

• https://mail.google.com/

Consulta también

• getSubject()

---

getCc()

Obtiene los destinatarios separados por comas que aparecen en el campo Cc de este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

Volver

String: Los destinatarios separados por comas que aparecen en el campo Cc de este mensaje.

Autorización

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

• https://mail.google.com/

Consulta también

• getTo()

---

getDate()

Obtiene la fecha y la hora de este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

Volver

Date: Es la fecha y hora de este mensaje.

Autorización

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

• https://mail.google.com/

---

getFrom()

Obtiene el remitente de este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

Volver

String: Es la dirección de correo electrónico del remitente del mensaje.

Autorización

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

• https://mail.google.com/

Consulta también

• getReplyTo()

---

getHeader(name)

Obtiene el valor de un encabezado RFC 2822 según el nombre del encabezado.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const message = thread.getMessages()[0];           // Get the first message.
Logger.log(
    message.getHeader('Message-ID'));  // Logs the Message-ID RFC 2822 header.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del encabezado de RFC, sin los dos puntos que lo separan del valor.

Volver

String: Es el valor del encabezado o una cadena vacía si el encabezado no existe en el mensaje.

Autorización

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

• https://mail.google.com/

---

getId()

Obtiene el ID de este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

Volver

String: Es el ID del mensaje.

---

getPlainBody()

Obtiene el contenido del cuerpo de este mensaje sin formato HTML. Esto es más complejo que getBody() y lleva más tiempo.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

Volver

String: Es el contenido sin formato del cuerpo de este mensaje.

Autorización

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

• https://mail.google.com/

Consulta también

• getSubject()

---

getRawContent()

Obtiene el contenido sin procesar de este mensaje. Esto equivale a la opción “Mostrar original” en la IU de Gmail.

Volver

String: Es el contenido sin procesar de este mensaje.

Autorización

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

• https://mail.google.com/

---

getReplyTo()

Obtiene la dirección de respuesta de este mensaje (por lo general, el remitente).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

Volver

String: Es la dirección de correo electrónico para las respuestas.

Autorización

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

• https://mail.google.com/

Consulta también

• getCc()

---

getSubject()

Obtiene el asunto de este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

Volver

String: Es el asunto de este mensaje.

Autorización

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

• https://mail.google.com/

Consulta también

• getAttachments()

---

getThread()

Obtiene la conversación que contiene este mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

Volver

GmailThread: Es el objeto GmailThread que contiene este mensaje.

Autorización

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

• https://mail.google.com/

---

getTo()

Obtiene los destinatarios de este mensaje separados por comas.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

Volver

String: Los destinatarios de este mensaje separados por comas.

Autorización

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

• https://mail.google.com/

Consulta también

• getCc()

---

isDraft()

Indica si este mensaje es un borrador.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Volver

Boolean: Indica si este mensaje es un borrador.

Autorización

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

• https://mail.google.com/

---

isInChats()

Obtiene si este mensaje es un chat.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Volver

Boolean: Indica si este mensaje es un chat.

---

isInInbox()

Obtiene si este mensaje está en la carpeta Recibidos.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

Volver

Boolean: Indica si este mensaje está en la carpeta Recibidos.

Autorización

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

• https://mail.google.com/

---

isInPriorityInbox()

Muestra true si este mensaje está en la carpeta Recibidos prioritarios; muestra false en caso contrario.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

Volver

Boolean: Indica si este mensaje está en la carpeta Prioritarios.

Autorización

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

• https://mail.google.com/

---

isInTrash()

Obtiene si este mensaje está en la papelera.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

Volver

Boolean: Indica si este mensaje está en la papelera.

---

isStarred()

Obtiene si este mensaje está destacado.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Volver

Boolean: Indica si este mensaje está destacado.

---

isUnread()

Indica si este mensaje está leído.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

Volver

Boolean: Es el estado de no leído de este mensaje.

Autorización

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

• https://mail.google.com/

---

markRead()

Marca el mensaje como leído.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

Volver

GmailMessage: Es un GmailMessage, útil para encadenar.

Autorización

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

• https://mail.google.com/

Consulta también

• isUnread()

---

markUnread()

Marca el mensaje como no leído.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

Volver

GmailMessage: Es un GmailMessage, útil para encadenar.

Autorización

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

• https://mail.google.com/

Consulta también

• isUnread()

---

moveToTrash()

Mueve el mensaje a la papelera.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

Volver

GmailMessage: Es un GmailMessage, útil para encadenar.

Autorización

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

• https://mail.google.com/

Consulta también

• isInTrash()

---

refresh()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

Volver

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

• https://mail.google.com/

---

reply(body)

Responde al remitente de este mensaje con la dirección de respuesta. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.

Volver

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

• https://mail.google.com/

Consulta también

• reply(body, options)
• replyAll(body)
• replyAll(body, options)

---

reply(body, options)

Responde al remitente de este mensaje con la dirección de respuesta, con argumentos opcionales.

El correo electrónico puede contener texto sin formato y un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

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

Volver

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

• https://mail.google.com/

Consulta también

• reply(body)
• replyAll(body)
• replyAll(body, options)

---

replyAll(body)

Responde al remitente con la dirección de respuesta y a todos los destinatarios de este mensaje. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.

Volver

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

• https://mail.google.com/

Consulta también

• reply(body)
• reply(body, options)
• replyAll(body, options)

---

replyAll(body, options)

Responde al remitente de este mensaje con la dirección de respuesta y todos los destinatarios, con argumentos opcionales.

El correo electrónico puede contener texto sin formato y un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

Parámetros

Nombre	Tipo	Descripción
body	String	El cuerpo del correo electrónico.
options	Object	Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

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

Volver

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

• https://mail.google.com/

Consulta también

• reply(body)
• reply(body, options)
• replyAll(body)

---

star()

Destaca el mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

Volver

GmailMessage: Es un GmailMessage, útil para encadenar.

Autorización

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

• https://mail.google.com/

Consulta también

• unstar()

---

unstar()

Deja de destacar el mensaje.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

Volver

GmailMessage: Es un GmailMessage, útil para encadenar.

Autorización

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

• https://mail.google.com/

Consulta también

• star()