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 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 las conversaciones, los mensajes y las etiquetas de Gmail.
`GmailAttachment`	Un archivo adjunto de Gmail
`GmailDraft`	Un borrador de mensaje creado por un usuario en la cuenta de Gmail de un usuario.
`GmailLabel`	Una etiqueta creada por un 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 nueva etiqueta de usuario con el nombre dado.
`deleteLabel(label)`	`GmailApp`	Borra la etiqueta especificada.
`getAliases()`	`String[]`	Obtiene una lista de los correos electrónicos configurados como alias de esta cuenta en Gmail.
`getDraft(draftId)`	`GmailDraft`	Recupera el borrador de un mensaje de correo electrónico por ID.
`getDraftMessages()`	`GmailMessage[]`	Recupera todos los borradores de mensajes.
`getDrafts()`	`GmailDraft[]`	Obtiene todos los mensajes en borrador 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, sin importar las etiquetas.
`getInboxUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en la bandeja de entrada.
`getMessageById(id)`	`GmailMessage`	Obtiene un mensaje por ID.
`getMessagesForThread(thread)`	`GmailMessage[]`	Recupera todos los mensajes del subproceso especificado.
`getMessagesForThreads(threads)`	`GmailMessage[][]`	Recupera todos los mensajes 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 el número de conversaciones no leídas en Prioritarios.
`getSpamThreads()`	`GmailThread[]`	Recupera todos los subprocesos de spam, sin importar las etiquetas.
`getSpamThreads(start, max)`	`GmailThread[]`	Recupera un rango de conversaciones de spam sin importar las etiquetas.
`getSpamUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que son spam.
`getStarredThreads()`	`GmailThread[]`	Recupera todos los subprocesos destacados, sin importar las etiquetas.
`getStarredThreads(start, max)`	`GmailThread[]`	Recupera un rango de subprocesos destacados, sin importar 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 sin importar las etiquetas.
`getUserLabelByName(name)`	`GmailLabel`	Recupera una etiqueta según su nombre.
`getUserLabels()`	`GmailLabel[]`	Recupera una lista de etiquetas creadas por el usuario.
`markMessageRead(message)`	`GmailApp`	Marca este mensaje como leído y lo obliga a actualizarse.
`markMessageUnread(message)`	`GmailApp`	Marca este mensaje como no leído y lo fuerza a actualizarse.
`markMessagesRead(messages)`	`GmailApp`	Marca estos mensajes como leídos y fuerza su actualización.
`markMessagesUnread(messages)`	`GmailApp`	Marca estos mensajes como no leídos y fuerza su actualización.
`markThreadImportant(thread)`	`GmailApp`	Marca esta conversación como importante y fuerza su actualización.
`markThreadRead(thread)`	`GmailApp`	Marca esta conversación como leída y fuerza su actualización.
`markThreadUnimportant(thread)`	`GmailApp`	Marca esta conversación como no importante y fuerza su actualización.
`markThreadUnread(thread)`	`GmailApp`	Marca esta conversación como no leída y fuerza a su actualización.
`markThreadsImportant(threads)`	`GmailApp`	Marca estas conversaciones como importantes y fuerza su 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 su actualización.
`markThreadsUnread(threads)`	`GmailApp`	Marca estas conversaciones como no leídas y fuerza a que se actualicen.
`moveMessageToTrash(message)`	`GmailApp`	Mueve el mensaje a la papelera y fuerza su actualización.
`moveMessagesToTrash(messages)`	`GmailApp`	Mueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes.
`moveThreadToArchive(thread)`	`GmailApp`	Mueve esta conversación al archivo y fuerza su actualización.
`moveThreadToInbox(thread)`	`GmailApp`	Mueve esta conversación a Recibidos y fuerza su actualización.
`moveThreadToSpam(thread)`	`GmailApp`	Mueve esta conversación a Spam y fuerza su actualización.
`moveThreadToTrash(thread)`	`GmailApp`	Mueve esta conversación a la papelera y fuerza su actualización.
`moveThreadsToArchive(threads)`	`GmailApp`	Mueve estos subprocesos al archivo y fuerza su actualización.
`moveThreadsToInbox(threads)`	`GmailApp`	Mueve estas conversaciones a Recibidos y fuerza su actualización.
`moveThreadsToSpam(threads)`	`GmailApp`	Mueve estas conversaciones a Spam y fuerza su actualización.
`moveThreadsToTrash(threads)`	`GmailApp`	Mueve estas conversaciones a la papelera y fuerza su actualización.
`refreshMessage(message)`	`GmailApp`	Vuelve a cargar el mensaje y el estado asociado de Gmail (es ú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 de Gmail (es ú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 (es ú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 (es útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etc.).
`search(query)`	`GmailThread[]`	Realiza la búsqueda en Gmail con la búsqueda indicada.
`search(query, start, max)`	`GmailThread[]`	Realiza la búsqueda en Gmail con la búsqueda indicada.
`sendEmail(recipient, subject, body)`	`GmailApp`	Envía un mensaje de correo electrónico.
`sendEmail(recipient, subject, body, options)`	`GmailApp`	Envía un 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 actuales de `GmailMessage`.
`starMessage(message)`	`GmailApp`	Destaca este mensaje con una estrella y lo obliga a actualizarse.
`starMessages(messages)`	`GmailApp`	Destaca con una estrella estos mensajes y los obliga a actualizarse.
`unstarMessage(message)`	`GmailApp`	Quita la estrella de este mensaje y fuerza su actualización.
`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 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 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`	Configura los datos almacenados en este BLOB.
`setContentType(contentType)`	`Blob`	Configura el tipo de contenido de los bytes en este BLOB.
`setContentTypeFromExtension()`	`Blob`	Establece el tipo de contenido de los bytes en este BLOB según la extensión de archivo.
`setDataFromString(string)`	`Blob`	Configura los datos de este BLOB a partir de una string con codificación UTF-8.
`setDataFromString(string, charset)`	`Blob`	Configura los datos de este BLOB a partir de 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 del 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 de la `GmailMessage` que representa a este borrador.
`send()`	`GmailMessage`	Se 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 de mensaje 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 determinado y fuerza su actualización (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Agrega esta etiqueta a los subprocesos determinados y fuerza la actualización de estos.
`deleteLabel()`	`void`	Borra esta etiqueta.
`getName()`	`String`	Obtiene el nombre de esta etiqueta.
`getThreads()`	`GmailThread[]`	Obtiene las conversaciones que están marcadas con esta etiqueta.
`getThreads(start, max)`	`GmailThread[]`	Obtiene un rango de conversaciones marcadas con esta etiqueta.
`getUnreadCount()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que se etiquetaron con esta etiqueta.
`removeFromThread(thread)`	`GmailLabel`	Quita esta etiqueta del subproceso en cuestión y fuerza su actualización.
`removeFromThreads(threads)`	`GmailLabel`	Quita esta etiqueta de los subprocesos determinados y fuerza la actualización de estos.

`GmailMessage`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`createDraftReply(body)`	`GmailDraft`	Crea un borrador para responder al remitente del mensaje utilizando la dirección de respuesta.
`createDraftReply(body, options)`	`GmailDraft`	Crea un borrador de mensaje para responder al remitente mediante 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 del mensaje.
`createDraftReplyAll(body, options)`	`GmailDraft`	Crea un borrador de mensaje para responder al remitente del mensaje utilizando 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 comas que se incluyeron 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 se incluyen en el campo Cc de este mensaje.
`getDate()`	`Date`	Obtiene la fecha y 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`	Obtiene 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 bandeja de entrada 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 está no 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 (es útil en caso de que las etiquetas, el estado de lectura, etc. hayan cambiado).
`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 del 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 como respuesta al remitente del último mensaje de la 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, utilizando 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, utilizando 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 del subproceso.
`getMessages()`	`GmailMessage[]`	Obtiene los mensajes de esta conversación.
`getPermalink()`	`String`	Se obtiene un vínculo permanente para esta conversación.
`hasStarredMessages()`	`Boolean`	Muestra si la conversación tiene mensajes destacados.
`isImportant()`	`Boolean`	Muestra si el subproceso está marcado como importante.
`isInChats()`	`Boolean`	Muestra si el subproceso tiene la etiqueta de chat.
`isInInbox()`	`Boolean`	Muestra si la conversación está en la bandeja de entrada.
`isInPriorityInbox()`	`Boolean`	Muestra true si este subproceso está en la bandeja de entrada prioritaria; de lo contrario, muestra false.
`isInSpam()`	`Boolean`	Muestra si el subproceso se marcó como spam.
`isInTrash()`	`Boolean`	Muestra si el subproceso está en la papelera.
`isUnread()`	`Boolean`	Muestra si la conversación 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`	Mover 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 (es ú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 de 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`	Responder 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.