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 el Servicio de correo, un servicio más simple que solo permite el envío de correos electrónicos.

Clases

Nombre	Descripción breve
`GmailApp`	Proporciona acceso a las conversaciones, los mensajes y las etiquetas de Gmail.
`GmailAttachment`	Un archivo adjunto de Gmail.
`GmailDraft`	Un mensaje de borrador creado por el usuario en su cuenta de Gmail.
`GmailLabel`	Es una etiqueta creada por el usuario en su cuenta de Gmail.
`GmailMessage`	Un mensaje en la cuenta de Gmail de un usuario
`GmailThread`	Un subproceso 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 nueva etiqueta de usuario con el nombre que se indique.
`deleteLabel(label)`	`GmailApp`	Borra la etiqueta especificada.
`getAliases()`	`String[]`	Obtiene una lista de los correos electrónicos configurados 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 mensajes de borrador.
`getDrafts()`	`GmailDraft[]`	Obtiene todos los mensajes de borradores de Gmail.
`getInboxThreads()`	`GmailThread[]`	Recupera todas las conversaciones de Recibidos, independientemente de las etiquetas.
`getInboxThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de Recibidos, independientemente de las etiquetas.
`getInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en la carpeta Recibidos.
`getMessageById(id)`	`GmailMessage`	Obtiene un mensaje por ID.
`getMessagesForThread(thread)`	`GmailMessage[]`	Recupera todos los mensajes de la conversación especificada.
`getMessagesForThreads(threads)`	`GmailMessage[][]`	Recupera todos los mensajes de las conversaciones especificadas.
`getPriorityInboxThreads()`	`GmailThread[]`	Recupera todos los subprocesos de Recibidos prioritarios, independientemente de las etiquetas.
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de la bandeja de entrada prioritaria, independientemente de las etiquetas.
`getPriorityInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en la bandeja de entrada prioritaria.
`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 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 favoritas, independientemente de las etiquetas.
`getStarredUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que se marcaron como favoritas.
`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 conversaciones de la papelera sin importar las etiquetas.
`getUserLabelByName(name)`	`GmailLabel`	Recupera una etiqueta según su nombre.
`getUserLabels()`	`GmailLabel[]`	Recupera una lista de las etiquetas creadas por el usuario.
`markMessageRead(message)`	`GmailApp`	Marca este mensaje como leído y lo actualiza de forma forzosa.
`markMessageUnread(message)`	`GmailApp`	Marca este mensaje como no leído y lo actualiza de forma forzosa.
`markMessagesRead(messages)`	`GmailApp`	Marca estos mensajes como leídos y los actualiza de forma forzosa.
`markMessagesUnread(messages)`	`GmailApp`	Marca estos mensajes como no leídos y los actualiza de forma forzosa.
`markThreadImportant(thread)`	`GmailApp`	Marca este subproceso como importante y lo obliga a actualizarse.
`markThreadRead(thread)`	`GmailApp`	Marca este subproceso como leído y lo obliga a actualizarse.
`markThreadUnimportant(thread)`	`GmailApp`	Marca este subproceso como no importante y lo obliga a actualizarse.
`markThreadUnread(thread)`	`GmailApp`	Marca este subproceso como no leído y lo obliga a actualizarse.
`markThreadsImportant(threads)`	`GmailApp`	Marca estos subprocesos como importantes y los obliga a actualizarse.
`markThreadsRead(threads)`	`GmailApp`	Marca estos subprocesos como leídos y los obliga a actualizarse.
`markThreadsUnimportant(threads)`	`GmailApp`	Marca estos subprocesos como no importantes y los obliga a actualizarse.
`markThreadsUnread(threads)`	`GmailApp`	Marca estos subprocesos como no leídos y los obliga a actualizarse.
`moveMessageToTrash(message)`	`GmailApp`	Mueve el mensaje a la papelera y lo actualiza de forma forzosa.
`moveMessagesToTrash(messages)`	`GmailApp`	Mueve los mensajes especificados a la papelera y los obliga a actualizarse.
`moveThreadToArchive(thread)`	`GmailApp`	Mueve este subproceso al archivo y lo fuerza a actualizarse.
`moveThreadToInbox(thread)`	`GmailApp`	Mueve esta conversación a Recibidos y la actualiza de forma forzosa.
`moveThreadToSpam(thread)`	`GmailApp`	Mueve este subproceso a spam y lo fuerza a actualizarse.
`moveThreadToTrash(thread)`	`GmailApp`	Mueve este subproceso a la papelera y lo actualiza de forma forzosa.
`moveThreadsToArchive(threads)`	`GmailApp`	Mueve estos subprocesos al archivo y los obliga a actualizarse.
`moveThreadsToInbox(threads)`	`GmailApp`	Mueve estos subprocesos a Recibidos y los obliga a actualizarse.
`moveThreadsToSpam(threads)`	`GmailApp`	Mueve estos subprocesos a spam y los obliga a actualizarse.
`moveThreadsToTrash(threads)`	`GmailApp`	Mueve estos subprocesos a la papelera y los obliga a actualizarse.
`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 la conversación y el estado asociado desde 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 con la consulta que se indica.
`search(query, start, max)`	`GmailThread[]`	Busca en Gmail con la consulta que se indica.
`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`	Establece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades `GmailMessage` actuales.
`starMessage(message)`	`GmailApp`	Agrega una estrella a este mensaje y lo obliga a actualizarse.
`starMessages(messages)`	`GmailApp`	Agrega estrellas a estos mensajes y los obliga a actualizarse.
`unstarMessage(message)`	`GmailApp`	Quita una estrella de este mensaje y lo actualiza de forma forzosa.
`unstarMessages(messages)`	`GmailApp`	Quita las estrellas de estos mensajes y los obliga a actualizarse.

`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 cadena con codificación UTF-8.
`getDataAsString(charset)`	`String`	Obtiene los datos de este objeto BLOB como una cadena con la codificación especificada.
`getHash()`	`String`	Obtiene el hash de contenido SHA1 de este archivo adjunto.
`getName()`	`String`	Obtiene el nombre de este blob.
`getSize()`	`Integer`	Obtiene el tamaño de este archivo 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 de este BLOB.
`setContentTypeFromExtension()`	`Blob`	Establece el tipo de contenido de los bytes de este blob según la extensión del archivo.
`setDataFromString(string)`	`Blob`	Establece los datos de este blob a partir de una cadena con codificación UTF-8.
`setDataFromString(string, charset)`	`Blob`	Establece los datos de este blob a partir de una cadena 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`	Borra este borrador de mensaje.
`getId()`	`String`	Obtiene el ID de este mensaje de borrador.
`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 mensaje 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 mensaje de borrador con argumentos opcionales.

`GmailLabel`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addToThread(thread)`	`GmailLabel`	Agrega esta etiqueta a la conversación determinada y la obliga a actualizarse (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Agrega esta etiqueta a los subprocesos determinados y los obliga a actualizarse.
`deleteLabel()`	`void`	Borra esta etiqueta.
`getName()`	`String`	Obtiene el nombre de esta etiqueta.
`getThreads()`	`GmailThread[]`	Obtiene los subprocesos que están marcados 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 determinado y lo obliga a actualizarse.
`removeFromThreads(threads)`	`GmailLabel`	Quita esta etiqueta de los subprocesos determinados y los obliga a actualizarse.

`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 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.

`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 con la dirección de respuesta.
`createDraftReply(body, options)`	`GmailDraft`	Crea un borrador de mensaje para responder 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 para responder al remitente del último mensaje de esta conversación, con la dirección de respuesta y todos los destinatarios de este mensaje.
`createDraftReplyAll(body, options)`	`GmailDraft`	Crea un borrador de mensaje para responder al remitente del último mensaje de esta conversación, con 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 esta conversación.
`getLastMessageDate()`	`Date`	Obtiene la fecha del mensaje más reciente de esta conversación.
`getMessageCount()`	`Integer`	Muestra la cantidad de mensajes en la conversación.
`getMessages()`	`GmailMessage[]`	Obtiene los mensajes de esta conversación.
`getPermalink()`	`String`	Obtiene un vínculo permanente para esta conversación.
`hasStarredMessages()`	`Boolean`	Muestra si el subproceso tiene algún mensaje destacado.
`isImportant()`	`Boolean`	Devuelve si el subproceso está marcado como importante.
`isInChats()`	`Boolean`	Muestra si el subproceso está etiquetado como chat.
`isInInbox()`	`Boolean`	Muestra si la conversación está en la carpeta Recibidos.
`isInPriorityInbox()`	`Boolean`	Muestra verdadero si esta conversación está en la carpeta Recibidos prioritarios; muestra falso en caso contrario.
`isInSpam()`	`Boolean`	Devuelve si la conversación está marcada como spam.
`isInTrash()`	`Boolean`	Muestra si el subproceso está en la papelera.
`isUnread()`	`Boolean`	Devuelve si el subproceso tiene algún mensaje no leído.
`markImportant()`	`GmailThread`	Marca este subproceso como importante.
`markRead()`	`GmailThread`	Marca este subproceso como leído.
`markUnimportant()`	`GmailThread`	Marca este subproceso como no importante.
`markUnread()`	`GmailThread`	Marca este subproceso como no leído.
`moveToArchive()`	`GmailThread`	Mueve esta conversación al archivo.
`moveToInbox()`	`GmailThread`	Mueve esta conversación a la carpeta Recibidos.
`moveToSpam()`	`GmailThread`	Mueve esta conversación a spam.
`moveToTrash()`	`GmailThread`	Mueve esta conversación a la papelera.
`refresh()`	`GmailThread`	Vuelve a cargar esta conversación y el estado asociado desde Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`removeLabel(label)`	`GmailThread`	Quita 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 (con la dirección de replyTo) y a todos los destinatarios del último mensaje de esta conversación.
`replyAll(body, options)`	`GmailThread`	Responde al remitente (con la dirección `replyTo`) y a todos los destinatarios del último mensaje de esta conversación con argumentos opcionales.