Gmail Service

Gmail

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 la cuenta de Gmail. Consulta también Mail Service, un servicio más simple que solo permite el envío de correos electrónicos.

Clases

Nombre	Descripción breve
GmailApp	Proporciona acceso a los hilos, mensajes y etiquetas de Gmail.
GmailAttachment	Es un archivo adjunto de Gmail.
GmailDraft	Es 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	Es un mensaje en la cuenta de Gmail de un usuario.
GmailThread	Es 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 etiqueta de usuario nueva con el nombre proporcionado.
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 en borrador.
getDrafts()	GmailDraft[]	Obtiene todos los mensajes de borrador de Gmail.
getInboxThreads()	GmailThread[]	Recupera todos los subprocesos de la bandeja de entrada, independientemente de las etiquetas.
getInboxThreads(start, max)	GmailThread[]	Recupera un rango de subprocesos de Recibidos, independientemente de las etiquetas.
getInboxUnreadCount()	Integer	Obtiene la cantidad de hilos no leídos en la carpeta de 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 los subprocesos especificados.
getPriorityInboxThreads()	GmailThread[]	Recupera todos los subprocesos de Recibidos prioritarios, independientemente de las etiquetas.
getPriorityInboxThreads(start, max)	GmailThread[]	Recupera un rango de hilos 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.
getSpamThreads()	GmailThread[]	Recupera todos los subprocesos de spam, independientemente de las etiquetas.
getSpamThreads(start, max)	GmailThread[]	Recupera un rango de subprocesos de spam, independientemente de las etiquetas.
getSpamUnreadCount()	Integer	Obtiene la cantidad de hilos no leídos que son spam.
getStarredThreads()	GmailThread[]	Recupera todos los subprocesos destacados, 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 se marcaron con una estrella.
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 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 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 la actualización de los mensajes.
markMessagesUnread(messages)	GmailApp	Marca estos mensajes como no leídos y fuerza la actualización de los mensajes.
markThreadImportant(thread)	GmailApp	Marca este hilo como importante y lo obliga a actualizarse.
markThreadRead(thread)	GmailApp	Marca este hilo como leído y fuerza su actualización.
markThreadUnimportant(thread)	GmailApp	Marca este hilo como no importante y fuerza su actualización.
markThreadUnread(thread)	GmailApp	Marca este hilo como no leído y fuerza su actualización.
markThreadsImportant(threads)	GmailApp	Marca estos subprocesos como importantes y los obliga a actualizarse.
markThreadsRead(threads)	GmailApp	Marca estos hilos como leídos y fuerza la actualización de los hilos.
markThreadsUnimportant(threads)	GmailApp	Marca estos hilos como no importantes y fuerza la actualización de los hilos.
markThreadsUnread(threads)	GmailApp	Marca estos hilos como no leídos y los obliga a actualizarse.
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 este subproceso al archivo y fuerza su actualización.
moveThreadToInbox(thread)	GmailApp	Mueve este subproceso a la bandeja de entrada y fuerza su actualización.
moveThreadToSpam(thread)	GmailApp	Mueve este hilo a spam y fuerza la actualización del hilo.
moveThreadToTrash(thread)	GmailApp	Mueve este subproceso a la papelera y fuerza su actualización.
moveThreadsToArchive(threads)	GmailApp	Mueve estos hilos al archivo y fuerza la actualización de los hilos.
moveThreadsToInbox(threads)	GmailApp	Mueve estos hilos a la bandeja de entrada y los obliga a actualizarse.
moveThreadsToSpam(threads)	GmailApp	Mueve estos hilos a spam y fuerza la actualización de los hilos.
moveThreadsToTrash(threads)	GmailApp	Mueve estos hilos a la papelera y los obliga a actualizarse.
refreshMessage(message)	GmailApp	Vuelve a cargar el mensaje y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
refreshMessages(messages)	GmailApp	Vuelve a cargar los mensajes y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
refreshThread(thread)	GmailApp	Vuelve a cargar el hilo y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
refreshThreads(threads)	GmailApp	Vuelve a cargar los subprocesos y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
search(query)	GmailThread[]	Busca en Gmail con la consulta proporcionada.
search(query, start, max)	GmailThread[]	Busca en Gmail con 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	Establece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades de 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 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	Devuelve una copia de este BLOB.
getAs(contentType)	Blob	Devuelve 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 en 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 BLOB como una cadena con la codificación especificada.
getHash()	String	Obtiene el hash de contenido SHA1 de este adjunto.
getName()	String	Obtiene el nombre de este blob.
getSize()	Integer	Obtiene el tamaño de este adjunto.
isGoogleType()	Boolean	Devuelve 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 en 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	Devuelve un objeto GmailMessage que representa este borrador.
getMessageId()	String	Devuelve el ID del GmailMessage que representa este borrador.
send()	GmailMessage	Envía este mensaje de correo electrónico en borrador.
update(recipient, subject, body)	GmailDraft	Reemplaza el contenido de este mensaje de borrador.
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 la actualización del subproceso (GmailThread.refresh()).
addToThreads(threads)	GmailLabel	Agrega esta etiqueta a los subprocesos determinados y los obliga a actualizarse.
deleteLabel()	void	Borra esta etiqueta.
getId()	String	Obtiene el ID de esta etiqueta.
getName()	String	Obtiene el nombre de esta etiqueta.
getThreads()	GmailThread[]	Obtiene los subprocesos marcados con esta etiqueta.
getThreads(start, max)	GmailThread[]	Obtiene un rango de subprocesos marcados con esta etiqueta.
getUnreadCount()	Integer	Obtiene la cantidad de subprocesos no leídos etiquetados con esta etiqueta.
removeFromThread(thread)	GmailLabel	Quita esta etiqueta del subproceso determinado y fuerza la actualización del subproceso.
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 usando la dirección de respuesta.
createDraftReply(body, options)	GmailDraft	Crea un borrador de mensaje para responder al remitente de este mensaje usando 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 mensaje de borrador para responder al remitente de este mensaje usando 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 incluidos 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 incluyeron en la copia 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 dado 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 el subproceso 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	Indica si este mensaje está en la bandeja de entrada.
isInPriorityInbox()	Boolean	Devuelve true si este mensaje está en la bandeja de entrada prioritaria; de lo contrario, devuelve false.
isInTrash()	Boolean	Obtiene si este mensaje está en la papelera.
isStarred()	Boolean	Obtiene si este mensaje está destacado.
isUnread()	Boolean	Obtiene si este mensaje no se leyó.
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 de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
reply(body)	GmailMessage	Responde al remitente de este mensaje usando la dirección de respuesta.
reply(body, options)	GmailMessage	Responde al remitente de este mensaje usando 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 usando la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
star()	GmailMessage	Destaca el mensaje.
unstar()	GmailMessage	Quita el mensaje de la lista de destacados.

GmailThread

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addLabel(label)	GmailThread	Agrega esta etiqueta al hilo.
createDraftReply(body)	GmailDraft	Crea un borrador de mensaje para responder al remitente del último mensaje de este subproceso con la dirección de respuesta.
createDraftReply(body, options)	GmailDraft	Crea un borrador de mensaje para responder al remitente del último mensaje de este subproceso 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 este hilo, con la dirección de respuesta y todos los destinatarios de este mensaje.
createDraftReplyAll(body, options)	GmailDraft	Crea un mensaje de borrador en respuesta al remitente del último mensaje de este hilo, 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[]	Devuelve las etiquetas creadas por el usuario en este subproceso.
getLastMessageDate()	Date	Obtiene la fecha del mensaje más reciente de este hilo.
getMessageCount()	Integer	Devuelve la cantidad de mensajes en el subproceso.
getMessages()	GmailMessage[]	Obtiene los mensajes de este subproceso.
getPermalink()	String	Obtiene un vínculo permanente para este hilo.
hasStarredMessages()	Boolean	Devuelve un valor que indica si el hilo tiene mensajes destacados.
isImportant()	Boolean	Devuelve si el subproceso está marcado como importante.
isInChats()	Boolean	Devuelve si el subproceso está etiquetado como chat.
isInInbox()	Boolean	Devuelve un valor que indica si el subproceso está en la carpeta Recibidos.
isInPriorityInbox()	Boolean	Devuelve verdadero si este subproceso está en la bandeja de entrada prioritaria; de lo contrario, devuelve falso.
isInSpam()	Boolean	Devuelve si el hilo está marcado como spam.
isInTrash()	Boolean	Devuelve un valor que indica si el subproceso está en la papelera.
isUnread()	Boolean	Devuelve un valor que indica si el subproceso tiene mensajes no leídos.
markImportant()	GmailThread	Marca este hilo como importante.
markRead()	GmailThread	Marca este hilo como leído.
markUnimportant()	GmailThread	Marca este hilo como no importante.
markUnread()	GmailThread	Marca este hilo como no leído.
moveToArchive()	GmailThread	Mueve este subproceso al archivo.
moveToInbox()	GmailThread	Mueve este hilo a la carpeta Recibidos.
moveToSpam()	GmailThread	Mueve este hilo a la carpeta de spam.
moveToTrash()	GmailThread	Mueve este hilo 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étera).
removeLabel(label)	GmailThread	Quita esta etiqueta del hilo.
reply(body)	GmailThread	Responde al remitente del último mensaje de este hilo con la dirección replyTo.
reply(body, options)	GmailThread	Responde al remitente del último mensaje de este hilo con la dirección replyTo, con argumentos opcionales.
replyAll(body)	GmailThread	Responder al remitente (con la dirección replyTo) y a todos los destinatarios del último mensaje de este hilo
replyAll(body, options)	GmailThread	Responde al remitente (con la dirección replyTo) y a todos los destinatarios del último mensaje de este hilo, con argumentos opcionales.