Class GmailMessage

GmailMessage

Un mensaje en la cuenta de Gmail de un usuario.

Métodos

MétodoTipo de datos que se muestraDescripción breve
createDraftReply(body)GmailDraftCrea un borrador de mensaje para responder al remitente de este mensaje mediante la dirección de respuesta.
createDraftReply(body, options)GmailDraftCrea un borrador de mensaje para responder al remitente de este mensaje usando la dirección de respuesta, con argumentos opcionales.
createDraftReplyAll(body)GmailDraftCrea un borrador de mensaje para responder al remitente usando la dirección de respuesta y todos los destinatarios de este mensaje.
createDraftReplyAll(body, options)GmailDraftCrea un borrador de mensaje para responder al remitente de este mensaje mediante la dirección de respuesta. todos los destinatarios, con argumentos opcionales.
forward(recipient)GmailMessageReenvía este mensaje a nuevos destinatarios.
forward(recipient, options)GmailMessageReenvía este mensaje a nuevos destinatarios, 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()StringObtiene los destinatarios separados por comas que se incluyen en el campo Cco de este mensaje.
getBody()StringObtiene el contenido HTML del cuerpo de este mensaje.
getCc()StringObtiene los destinatarios separados por comas en el campo Cc de este mensaje.
getDate()DateObtiene la fecha y la hora de este mensaje.
getFrom()StringObtiene el remitente de este mensaje.
getHeader(name)StringObtiene el valor de un encabezado RFC 2822 según el nombre del encabezado.
getId()StringObtiene el ID de este mensaje.
getPlainBody()StringObtiene el contenido del cuerpo de este mensaje sin formato HTML.
getRawContent()StringObtiene el contenido sin procesar de este mensaje.
getReplyTo()StringObtiene la dirección de respuesta de este mensaje (por lo general, del remitente).
getSubject()StringObtiene el asunto de este mensaje.
getThread()GmailThreadObtiene la conversación que contiene este mensaje.
getTo()StringObtiene los destinatarios separados por comas de este mensaje.
isDraft()BooleanObtiene si este mensaje es un borrador.
isInChats()BooleanObtiene si este mensaje es un chat.
isInInbox()BooleanDetermina si este mensaje está en la bandeja de entrada.
isInPriorityInbox()BooleanMuestra true si este mensaje está en Prioritarios. De lo contrario, muestra false.
isInTrash()BooleanObtiene si el mensaje está en la papelera.
isStarred()BooleanObtiene si se destaca este mensaje.
isUnread()BooleanSe obtiene si este mensaje no es leído.
markRead()GmailMessageMarca el mensaje como leído.
markUnread()GmailMessageMarca el mensaje como no leído.
moveToTrash()GmailMessageMueve el mensaje a la papelera.
refresh()GmailMessageVuelve a cargar este mensaje y el estado asociado desde Gmail (útil en caso de que las etiquetas, el estado de lectura, etc.).
reply(body)GmailMessageResponde al remitente de este mensaje utilizando la dirección de respuesta.
reply(body, options)GmailMessageResponde al remitente de este mensaje usando la dirección de respuesta, con argumentos opcionales.
replyAll(body)GmailMessageResponde al remitente con la dirección de respuesta y a todos los destinatarios de este mensaje.
replyAll(body, options)GmailMessageResponde al remitente de este mensaje con la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
star()GmailMessageDestaca el mensaje con una estrella.
unstar()GmailMessageDeja de destacar el mensaje.

Documentación detallada

createDraftReply(body)

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

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

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.

Volver

GmailDraft: Es el borrador del mensaje 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


createDraftReply(body, options)

Crea un borrador de mensaje para responder al remitente de este mensaje usando 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 (incluida la encabezados) es quota limitado.

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
attachmentsBlobSource[]un array de archivos para enviar con el correo electrónico
bccStringuna lista separada por comas de direcciones de correo electrónico a Cco
ccStringuna lista de direcciones de correo electrónico separadas por comas para agregar en Cc
fromStringla dirección desde la que se debe enviar el correo electrónico, que debe ser una de los valores que muestra GmailApp.getAliases()
htmlBodyStringcuando se establece, los dispositivos capaces de renderizar el código HTML lo usan en lugar de el argumento de cuerpo requerido; puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico
inlineImagesObjectun 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" />
nameStringel nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
replyToStringuna dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)
subjectStringUna nueva línea de asunto para el correo electrónico, de hasta 250 caracteres.

Volver

GmailDraft: Es el borrador del mensaje 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


createDraftReplyAll(body)

Crea un borrador de mensaje para responder al remitente usando 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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.

Volver

GmailDraft: Es el borrador del mensaje 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


createDraftReplyAll(body, options)

Crea un borrador de mensaje para responder al remitente de este mensaje mediante la dirección de respuesta. 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 (incluida la encabezados) es quota limitado.

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

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
attachmentsBlobSource[]un array de archivos para enviar con el correo electrónico
bccStringuna lista separada por comas de direcciones de correo electrónico a Cco
ccStringuna lista de direcciones de correo electrónico separadas por comas para agregar en Cc
fromStringla dirección desde la que se debe enviar el correo electrónico, que debe ser una de los valores que muestra GmailApp.getAliases()
htmlBodyStringcuando se establece, los dispositivos capaces de renderizar el código HTML lo usan en lugar de el argumento de cuerpo requerido; puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico
inlineImagesObjectun 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" />
nameStringel nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
replyToStringuna dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)
subjectStringUna nueva línea de asunto para el correo electrónico, de hasta 250 caracteres.

Volver

GmailDraft: Es el borrador del mensaje 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


forward(recipient)

Reenvía este mensaje a nuevos destinatarios. 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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

Parámetros

NombreTipoDescripción
recipientStringUna lista de direcciones de correo electrónico separadas por comas.

Volver

GmailMessage: Este mensaje es ú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


forward(recipient, options)

Reenvía este mensaje a nuevos 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) es cuota limitado.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

Parámetros

NombreTipoDescripción
recipientStringUna lista de direcciones de correo electrónico separadas por comas.
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
attachmentsBlobSource[]un array de archivos para enviar con el correo electrónico
bccStringuna lista separada por comas de direcciones de correo electrónico a Cco
ccStringuna lista de direcciones de correo electrónico separadas por comas para agregar en Cc
fromStringla dirección desde la que se debe enviar el correo electrónico, que debe ser una de los valores que muestra GmailApp.getAliases()
htmlBodyStringcuando se establece, los dispositivos capaces de renderizar el código HTML lo usan en lugar de el argumento de cuerpo requerido; puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico
inlineImagesObjectun 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" />
nameStringel nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
noReplyBooleantrue 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.
replyToStringuna dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)
subjectStringUna nueva línea de asunto para el correo electrónico, de hasta 250 caracteres.

Volver

GmailMessage: Este mensaje es ú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


getAttachments()

Obtiene todos los archivos adjuntos de este mensaje.

Volver

GmailAttachment[]: Es un array de 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getAttachments(options)

Obtiene todos los archivos adjuntos de este mensaje.

Parámetros

NombreTipoDescripción
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
includeInlineImagesBooleantrue si el array de Blob que se muestra Los archivos adjuntos deben incluir imágenes intercaladas (el valor predeterminado es true).
includeAttachmentsBooleantrue si el array de Blob que se muestra Los archivos adjuntos deben incluir archivos adjuntos normales (no intercalados) (el valor predeterminado es true).

Volver

GmailAttachment[]: Es un array de 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getBcc()

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

Este campo está vacío para todos los mensajes recibidos, por definición.

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

Volver

String: Los destinatarios separados por comas que se incluyeron 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getBody()

Obtiene el contenido HTML del cuerpo de este mensaje.

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

Volver

String: 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getCc()

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

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

Volver

String: Los destinatarios separados por comas que se agregaron 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getDate()

Obtiene la fecha y la hora de este mensaje.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getFrom()

Obtiene el remitente de este mensaje.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getHeader(name)

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

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

Parámetros

NombreTipoDescripción
nameStringEl nombre del encabezado RFC, sin los dos puntos que lo separan del valor.

Volver

String: Es el valor del encabezado o una string 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getId()

Obtiene el ID de este mensaje.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var 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 tarda más tiempo.

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

Volver

String: Es el contenido del cuerpo sin formato 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getRawContent()

Obtiene el contenido sin procesar de este mensaje. Esto equivale a "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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getReplyTo()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getSubject()

Obtiene el asunto de este mensaje.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


getThread()

Obtiene la conversación que contiene este mensaje.

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

Volver

GmailThread: Es la conversación de Gmail 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getTo()

Obtiene los destinatarios separados por comas de este mensaje.

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

Volver

String: Indica los destinatarios separados por comas 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


isDraft()

Obtiene si este mensaje es un borrador.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

Volver

Boolean: Indica si el 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

isInChats()

Obtiene si este mensaje es un chat.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

Volver

Boolean: Indica si el mensaje es un chat.


isInInbox()

Determina si este mensaje está en la bandeja de entrada.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 alcances, o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

isInPriorityInbox()

Muestra true si este mensaje está en Prioritarios. De lo contrario, muestra false.

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var 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 se encuentra 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/

isInTrash()

Obtiene si el mensaje está en la papelera.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

Volver

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


isStarred()

Obtiene si se destaca este mensaje.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

Volver

Boolean: Indica si se destacó este mensaje.


isUnread()

Se obtiene si este mensaje no es leído.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

Volver

Boolean: El estado de este mensaje no leído.

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/

markRead()

Marca el mensaje como leído.

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

Volver

GmailMessage: Este es este GmailMessage, ú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


markUnread()

Marca el mensaje como no leído.

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

Volver

GmailMessage: Este es este GmailMessage, ú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


moveToTrash()

Mueve el mensaje a la papelera.

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

Volver

GmailMessage: Este es este GmailMessage, ú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


refresh()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 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/

reply(body)

Responde al remitente de este mensaje utilizando la dirección de respuesta. El tamaño del correo electrónico (incluidos los encabezados) es cuota limitado.

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

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.

Volver

GmailMessage: Este mensaje es ú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


reply(body, options)

Responde al remitente de este mensaje usando 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) es cuota limitado.

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

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
attachmentsBlobSource[]un array de archivos para enviar con el correo electrónico
bccStringuna lista separada por comas de direcciones de correo electrónico a Cco
ccStringuna lista de direcciones de correo electrónico separadas por comas para agregar en Cc
fromStringla dirección desde la que se debe enviar el correo electrónico, que debe ser una de los valores que muestra GmailApp.getAliases()
htmlBodyStringcuando se establece, los dispositivos capaces de renderizar el código HTML lo usan en lugar de el argumento de cuerpo requerido; puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico
inlineImagesObjectun 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" />
nameStringel nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
noReplyBooleantrue 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.
replyToStringuna dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)
subjectStringUna nueva línea de asunto para el correo electrónico, de hasta 250 caracteres.

Volver

GmailMessage: Este mensaje es ú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


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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.

Volver

GmailMessage: Este mensaje es ú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


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) es cuota limitado.

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

Parámetros

NombreTipoDescripción
bodyStringEl cuerpo del correo electrónico.
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
attachmentsBlobSource[]un array de archivos para enviar con el correo electrónico
bccStringuna lista separada por comas de direcciones de correo electrónico a Cco
ccStringuna lista de direcciones de correo electrónico separadas por comas para agregar en Cc
fromStringla dirección desde la que se debe enviar el correo electrónico, que debe ser una de los valores que muestra GmailApp.getAliases()
htmlBodyStringcuando se establece, los dispositivos capaces de renderizar el código HTML lo usan en lugar de el argumento de cuerpo requerido; puedes agregar un campo inlineImages opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico
inlineImagesObjectun 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" />
nameStringel nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
noReplyBooleantrue 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.
replyToStringuna dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)
subjectStringUna nueva línea de asunto para el correo electrónico, de hasta 250 caracteres.

Volver

GmailMessage: Este mensaje es ú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


star()

Destaca el mensaje con una estrella.

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

Volver

GmailMessage: Este es este GmailMessage, ú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


unstar()

Deja de destacar el mensaje.

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

Volver

GmailMessage: Este es este GmailMessage, ú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