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

Gmail Service

Este servicio te permite enviar correos electrónicos, redactar borradores, administrar etiquetas, marcar mensajes y conversaciones, y realizar una variedad de otras tareas de administración de cuentas de Gmail. Consulta también Servicio de correo electrónico, un servicio más simple que solo permite el envío de correos electrónicos.

Clases

Nombre	Descripción breve
`GmailApp`	Proporciona acceso a conversaciones, etiquetas y mensajes de Gmail.
`GmailAttachment`	Un archivo adjunto de Gmail.
`GmailDraft`	Un mensaje en borrador creado por el usuario en la cuenta de Gmail de un usuario
`GmailLabel`	Una etiqueta creada por el usuario en la cuenta de Gmail de un usuario.
`GmailMessage`	Un mensaje en la cuenta de Gmail de un usuario.
`GmailThread`	Una conversación en la cuenta de Gmail de un usuario.

`GmailApp`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`createDraft(recipient, subject, body)`	`GmailDraft`	Crea un borrador de mensaje de correo electrónico.
`createDraft(recipient, subject, body, options)`	`GmailDraft`	Crea un borrador de mensaje de correo electrónico con argumentos opcionales.
`createLabel(name)`	`GmailLabel`	Crea una etiqueta de usuario nueva con el nombre específico.
`deleteLabel(label)`	`GmailApp`	Borra la etiqueta especificada.
`getAliases()`	`String[]`	Obtiene una lista de los correos electrónicos que se configuran como alias para esta cuenta en Gmail.
`getDraft(draftId)`	`GmailDraft`	Recuperar 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 Inbox, independientemente de las etiquetas.
`getInboxThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de Inbox, independientemente de las etiquetas.
`getInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en Recibidos.
`getMessageById(id)`	`GmailMessage`	Obtiene un mensaje por ID.
`getMessagesForThread(thread)`	`GmailMessage[]`	Recupera todos los mensajes en la conversación especificada.
`getMessagesForThreads(threads)`	`GmailMessage[][]`	Recupera todos los mensajes en las conversaciones especificadas.
`getPriorityInboxThreads()`	`GmailThread[]`	Recupera todas las conversaciones de Prioritarios independientemente de las etiquetas.
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de Prioritarios independientemente de las etiquetas.
`getPriorityInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en Prioritarios.
`getSpamThreads()`	`GmailThread[]`	Recupera todas las conversaciones de spam, independientemente de las etiquetas.
`getSpamThreads(start, max)`	`GmailThread[]`	Recupera una variedad de conversaciones de spam, independientemente de las etiquetas.
`getSpamUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que son spam.
`getStarredThreads()`	`GmailThread[]`	Recupera todas las conversaciones destacadas, independientemente de las etiquetas.
`getStarredThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones destacadas independientemente de las etiquetas.
`getStarredUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que están destacadas.
`getThreadById(id)`	`GmailThread`	Obtiene un subproceso por ID.
`getTrashThreads()`	`GmailThread[]`	Recupera todos los subprocesos de la papelera, independientemente de las etiquetas.
`getTrashThreads(start, max)`	`GmailThread[]`	Recupera un rango de subprocesos de la papelera independientemente de las etiquetas.
`getUserLabelByName(name)`	`GmailLabel`	Recupera una etiqueta en función del nombre de la etiqueta.
`getUserLabels()`	`GmailLabel[]`	Recupera una lista de etiquetas creadas por el usuario.
`markMessageRead(message)`	`GmailApp`	Marca este mensaje como leído y fuerza su actualización.
`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 la actualización de los mensajes.
`markThreadImportant(thread)`	`GmailApp`	Marca este subproceso como importante y fuerza su actualización.
`markThreadRead(thread)`	`GmailApp`	Marca este subproceso como leído y fuerza su actualización.
`markThreadUnimportant(thread)`	`GmailApp`	Marca este subproceso como no importante y fuerza la actualización.
`markThreadUnread(thread)`	`GmailApp`	Marca este subproceso como no leído y fuerza su actualización.
`markThreadsImportant(threads)`	`GmailApp`	Marca estas conversaciones como importantes y fuerza la actualización.
`markThreadsRead(threads)`	`GmailApp`	Marca estos subprocesos como leídos y fuerza su actualización.
`markThreadsUnimportant(threads)`	`GmailApp`	Marca estas conversaciones como no importantes y fuerza la actualización.
`markThreadsUnread(threads)`	`GmailApp`	Marca estas conversaciones como no leídas y fuerza su actualización.
`moveMessageToTrash(message)`	`GmailApp`	Envía 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 este subproceso al archivo y fuerza el proceso de actualización.
`moveThreadToInbox(thread)`	`GmailApp`	Mueve este subproceso a la carpeta Recibidos y fuerza su actualización.
`moveThreadToSpam(thread)`	`GmailApp`	Mueve este subproceso a la carpeta de spam y fuerza su actualización.
`moveThreadToTrash(thread)`	`GmailApp`	Se envía este subproceso a la papelera y se fuerza su actualización.
`moveThreadsToArchive(threads)`	`GmailApp`	Mueve estas conversaciones al archivo y fuerza la actualización de las conversaciones.
`moveThreadsToInbox(threads)`	`GmailApp`	Mueve estas conversaciones a Recibidos y fuerza la actualización de las conversaciones.
`moveThreadsToSpam(threads)`	`GmailApp`	Traslada 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 su actualización.
`refreshMessage(message)`	`GmailApp`	Vuelve a cargar el mensaje y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`refreshMessages(messages)`	`GmailApp`	Vuelve a cargar los mensajes y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`refreshThread(thread)`	`GmailApp`	Vuelve a cargar el subproceso y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`refreshThreads(threads)`	`GmailApp`	Vuelve a cargar las conversaciones y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`search(query)`	`GmailThread[]`	Busca en Gmail la consulta proporcionada.
`search(query, start, max)`	`GmailThread[]`	Busca en Gmail la consulta proporcionada.
`sendEmail(recipient, subject, body)`	`GmailApp`	Envía un mensaje de correo electrónico.
`sendEmail(recipient, subject, body, options)`	`GmailApp`	Envía un mensaje de correo electrónico con argumentos opcionales.
`setCurrentMessageAccessToken(accessToken)`	`void`	Configura el token actual de acceso a mensajes, que permite a la secuencia de comandos acceder a las propiedades actuales de `GmailMessage`.
`starMessage(message)`	`GmailApp`	Agrega una estrella a este mensaje y fuerza su actualización.
`starMessages(messages)`	`GmailApp`	Agrega estrellas a estos mensajes y fuerza su actualización.
`unstarMessage(message)`	`GmailApp`	Elimina una estrella de este mensaje y fuerza su actualización.
`unstarMessages(messages)`	`GmailApp`	Quita las estrellas de estos mensajes y fuerza su actualización.

`GmailAttachment`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`copyBlob()`	`Blob`	Muestra una copia de este BLOB.
`getAs(contentType)`	`Blob`	Muestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado.
`getBytes()`	`Byte[]`	Obtiene los datos almacenados en este BLOB.
`getContentType()`	`String`	Obtiene el tipo de contenido de los bytes de este BLOB.
`getDataAsString()`	`String`	Obtiene los datos de este BLOB como una string con codificación UTF-8.
`getDataAsString(charset)`	`String`	Obtiene los datos de este BLOB como una string con la codificación especificada.
`getHash()`	`String`	Obtiene el hash de contenido SHA1 para este adjunto.
`getName()`	`String`	Obtiene el nombre de este BLOB.
`getSize()`	`Integer`	Obtiene el tamaño de este adjunto.
`isGoogleType()`	`Boolean`	Muestra si este BLOB es un archivo de Google Workspace (Hojas de cálculo, Documentos, etcétera).
`setBytes(data)`	`Blob`	Establece los datos almacenados en este BLOB.
`setContentType(contentType)`	`Blob`	Establece el tipo de contenido de los bytes en este BLOB.
`setContentTypeFromExtension()`	`Blob`	Establece el tipo de contenido de los bytes de este BLOB en función de la extensión de archivo.
`setDataFromString(string)`	`Blob`	Establece los datos de este BLOB en una string con codificación UTF-8.
`setDataFromString(string, charset)`	`Blob`	Configura los datos de este BLOB desde una string con la codificación especificada.
`setName(name)`	`Blob`	Establece el nombre de este BLOB.

`GmailDraft`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`deleteDraft()`	`void`	Elimina este borrador de mensaje.
`getId()`	`String`	Obtiene el ID de este borrador de mensaje.
`getMessage()`	`GmailMessage`	Muestra un GmailMessage que representa este borrador.
`getMessageId()`	`String`	Muestra el ID del `GmailMessage` que representa este borrador.
`send()`	`GmailMessage`	Envía este borrador de correo electrónico.
`update(recipient, subject, body)`	`GmailDraft`	Reemplaza el contenido de este borrador de mensaje.
`update(recipient, subject, body, options)`	`GmailDraft`	Reemplaza el contenido de este borrador con argumentos opcionales.

`GmailLabel`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addToThread(thread)`	`GmailLabel`	Agrega esta etiqueta al subproceso dado y fuerza la actualización (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Agrega esta etiqueta a los subprocesos determinados y fuerza la actualización de los subprocesos.
`deleteLabel()`	`void`	Borra esta etiqueta.
`getName()`	`String`	Obtiene el nombre de esta etiqueta.
`getThreads()`	`GmailThread[]`	Obtiene las conversaciones marcadas con esta etiqueta.
`getThreads(start, max)`	`GmailThread[]`	Obtiene un rango de subprocesos marcados con esta etiqueta.
`getUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas etiquetadas con esta etiqueta.
`removeFromThread(thread)`	`GmailLabel`	Quita esta etiqueta del subproceso dado y fuerza la actualización.
`removeFromThreads(threads)`	`GmailLabel`	Quita esta etiqueta de los subprocesos indicados y fuerza la actualización de los subprocesos.

`GmailMessage`

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 mediante la dirección de respuesta, con argumentos opcionales.
`createDraftReplyAll(body)`	`GmailDraft`	Crea un borrador de mensaje que responda al remitente con la dirección de respuesta y todos los destinatarios de este mensaje.
`createDraftReplyAll(body, options)`	`GmailDraft`	Crea un borrador de mensaje en respuesta 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 nuevos destinatarios.
`forward(recipient, options)`	`GmailMessage`	Reenví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()`	`String`	Obtiene los destinatarios separados por coma en copia en este mensaje.
`getBody()`	`String`	Obtiene el contenido HTML del cuerpo de este mensaje.
`getCc()`	`String`	Obtiene los destinatarios separados por comas en copia en 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 con 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 separados por comas de este mensaje.
`isDraft()`	`Boolean`	Obtiene si este mensaje es un borrador.
`isInChats()`	`Boolean`	Obtiene si este mensaje es un chat.
`isInInbox()`	`Boolean`	Obtiene si este mensaje está en Recibidos.
`isInPriorityInbox()`	`Boolean`	Muestra `true` si este mensaje está en la carpeta Prioritarios; de lo contrario, muestra `false`.
`isInTrash()`	`Boolean`	Obtiene si el mensaje está en la papelera.
`isStarred()`	`Boolean`	Obtiene si este mensaje está destacado.
`isUnread()`	`Boolean`	Obtiene si este mensaje no está leído.
`markRead()`	`GmailMessage`	Marca el mensaje como leído.
`markUnread()`	`GmailMessage`	Marca el mensaje como no leído.
`moveToTrash()`	`GmailMessage`	Envía el mensaje a la papelera.
`refresh()`	`GmailMessage`	Vuelve a cargar este mensaje y el estado asociado de 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 utilizando la dirección de respuesta, con argumentos opcionales.
`replyAll(body)`	`GmailMessage`	Responde al remitente con la dirección de respuesta y 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`	Quita la estrella del mensaje.

`GmailThread`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addLabel(label)`	`GmailThread`	Agrega esta etiqueta a la conversación.
`createDraftReply(body)`	`GmailDraft`	Crea un borrador de mensaje para responder al remitente del último mensaje de esta conversación mediante la dirección de respuesta.
`createDraftReply(body, options)`	`GmailDraft`	Crea un borrador de mensaje que responde al remitente del último mensaje de esta conversación con la dirección de respuesta, con argumentos opcionales.
`createDraftReplyAll(body)`	`GmailDraft`	Crea un borrador de mensaje en respuesta al remitente del último mensaje de esta conversación mediante 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 del último mensaje de esta conversación mediante la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
`getFirstMessageSubject()`	`String`	Obtiene el asunto del primer mensaje de la conversación.
`getId()`	`String`	Obtiene el ID de este subproceso.
`getLabels()`	`GmailLabel[]`	Muestra las etiquetas creadas por el usuario en este subproceso.
`getLastMessageDate()`	`Date`	Obtiene la fecha del mensaje más reciente de esta conversación.
`getMessageCount()`	`Integer`	Muestra el número de mensajes en el subproceso.
`getMessages()`	`GmailMessage[]`	Obtiene los mensajes de esta conversación.
`getPermalink()`	`String`	Obtiene un vínculo permanente para este subproceso.
`hasStarredMessages()`	`Boolean`	Muestra si el subproceso tiene mensajes destacados.
`isImportant()`	`Boolean`	Muestra si el subproceso está marcado como importante.
`isInChats()`	`Boolean`	Muestra si el subproceso está etiquetado como chat.
`isInInbox()`	`Boolean`	Muestra si el subproceso está en Recibidos.
`isInPriorityInbox()`	`Boolean`	Muestra true si este subproceso está en la carpeta Prioritarios; de lo contrario, muestra false.
`isInSpam()`	`Boolean`	Muestra si el subproceso está marcado como spam.
`isInTrash()`	`Boolean`	Muestra si el subproceso está en la papelera.
`isUnread()`	`Boolean`	Muestra si el subproceso tiene mensajes no leídos.
`markImportant()`	`GmailThread`	Marca esta conversación como importante.
`markRead()`	`GmailThread`	Marca esta conversación como leída.
`markUnimportant()`	`GmailThread`	Marca esta conversación como no importante.
`markUnread()`	`GmailThread`	Marca esta conversación como no leída.
`moveToArchive()`	`GmailThread`	Mueve esta conversación al archivo.
`moveToInbox()`	`GmailThread`	Mueve esta conversación a Recibidos.
`moveToSpam()`	`GmailThread`	Esta conversación se envía a la carpeta Spam.
`moveToTrash()`	`GmailThread`	Se envía este subproceso a la papelera.
`refresh()`	`GmailThread`	Vuelve a cargar este subproceso y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`removeLabel(label)`	`GmailThread`	Elimina esta etiqueta de la conversación.
`reply(body)`	`GmailThread`	Responde al remitente del último mensaje de esta conversación con la dirección ReplyTo.
`reply(body, options)`	`GmailThread`	Responde al remitente del último mensaje de esta conversación con la dirección ReplyTo, con argumentos opcionales.
`replyAll(body)`	`GmailThread`	Responde al remitente (mediante la dirección ReplyTo) y a todos los destinatarios del último mensaje de esta conversación.
`replyAll(body, options)`	`GmailThread`	Responde al remitente (mediante la dirección `replyTo`) y a todos los destinatarios del último mensaje de esta conversación con argumentos opcionales.