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

NombreDescripción breve
GmailAppProporciona acceso a los hilos, mensajes y etiquetas de Gmail.
GmailAttachmentEs un archivo adjunto de Gmail.
GmailDraftEs un mensaje de borrador creado por el usuario en su cuenta de Gmail.
GmailLabelEs una etiqueta creada por el usuario en su cuenta de Gmail.
GmailMessageEs un mensaje en la cuenta de Gmail de un usuario.
GmailThreadEs un subproceso en la cuenta de Gmail de un usuario.

GmailApp

Métodos

MétodoTipo de datos que se muestraDescripción breve
createDraft(recipient, subject, body)GmailDraftCrea un borrador de mensaje de correo electrónico.
createDraft(recipient, subject, body, options)GmailDraftCrea un borrador de mensaje de correo electrónico con argumentos opcionales.
createLabel(name)GmailLabelCrea una etiqueta de usuario nueva con el nombre proporcionado.
deleteLabel(label)GmailAppBorra la etiqueta especificada.
getAliases()String[]Obtiene una lista de los correos electrónicos configurados como alias para esta cuenta en Gmail.
getDraft(draftId)GmailDraftRecupera 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()IntegerObtiene la cantidad de hilos no leídos en la carpeta de Recibidos.
getMessageById(id)GmailMessageObtiene 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()IntegerObtiene 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()IntegerObtiene 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()IntegerObtiene la cantidad de conversaciones no leídas que se marcaron con una estrella.
getThreadById(id)GmailThreadObtiene 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)GmailLabelRecupera una etiqueta según su nombre.
getUserLabels()GmailLabel[]Recupera una lista de las etiquetas creadas por el usuario.
markMessageRead(message)GmailAppMarca este mensaje como leído y fuerza su actualización.
markMessageUnread(message)GmailAppMarca este mensaje como no leído y fuerza su actualización.
markMessagesRead(messages)GmailAppMarca estos mensajes como leídos y fuerza la actualización de los mensajes.
markMessagesUnread(messages)GmailAppMarca estos mensajes como no leídos y fuerza la actualización de los mensajes.
markThreadImportant(thread)GmailAppMarca este hilo como importante y lo obliga a actualizarse.
markThreadRead(thread)GmailAppMarca este hilo como leído y fuerza su actualización.
markThreadUnimportant(thread)GmailAppMarca este hilo como no importante y fuerza su actualización.
markThreadUnread(thread)GmailAppMarca este hilo como no leído y fuerza su actualización.
markThreadsImportant(threads)GmailAppMarca estos subprocesos como importantes y los obliga a actualizarse.
markThreadsRead(threads)GmailAppMarca estos hilos como leídos y fuerza la actualización de los hilos.
markThreadsUnimportant(threads)GmailAppMarca estos hilos como no importantes y fuerza la actualización de los hilos.
markThreadsUnread(threads)GmailAppMarca estos hilos como no leídos y los obliga a actualizarse.
moveMessageToTrash(message)GmailAppMueve el mensaje a la papelera y fuerza su actualización.
moveMessagesToTrash(messages)GmailAppMueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes.
moveThreadToArchive(thread)GmailAppMueve este subproceso al archivo y fuerza su actualización.
moveThreadToInbox(thread)GmailAppMueve este subproceso a la bandeja de entrada y fuerza su actualización.
moveThreadToSpam(thread)GmailAppMueve este hilo a spam y fuerza la actualización del hilo.
moveThreadToTrash(thread)GmailAppMueve este subproceso a la papelera y fuerza su actualización.
moveThreadsToArchive(threads)GmailAppMueve estos hilos al archivo y fuerza la actualización de los hilos.
moveThreadsToInbox(threads)GmailAppMueve estos hilos a la bandeja de entrada y los obliga a actualizarse.
moveThreadsToSpam(threads)GmailAppMueve estos hilos a spam y fuerza la actualización de los hilos.
moveThreadsToTrash(threads)GmailAppMueve estos hilos a la papelera y los obliga a actualizarse.
refreshMessage(message)GmailAppVuelve 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)GmailAppVuelve 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)GmailAppVuelve 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)GmailAppVuelve 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)GmailAppEnvía un mensaje de correo electrónico.
sendEmail(recipient, subject, body, options)GmailAppEnvía un mensaje de correo electrónico con argumentos opcionales.
setCurrentMessageAccessToken(accessToken)voidEstablece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades de GmailMessage actuales.
starMessage(message)GmailAppAgrega una estrella a este mensaje y lo obliga a actualizarse.
starMessages(messages)GmailAppAgrega estrellas a estos mensajes y los obliga a actualizarse.
unstarMessage(message)GmailAppQuita la estrella de este mensaje y fuerza su actualización.
unstarMessages(messages)GmailAppQuita las estrellas de estos mensajes y los obliga a actualizarse.

GmailAttachment

Métodos

MétodoTipo de datos que se muestraDescripción breve
copyBlob()BlobDevuelve una copia de este BLOB.
getAs(contentType)BlobDevuelve 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()StringObtiene el tipo de contenido de los bytes en este BLOB.
getDataAsString()StringObtiene los datos de este BLOB como una cadena con codificación UTF-8.
getDataAsString(charset)StringObtiene los datos de este BLOB como una cadena con la codificación especificada.
getHash()StringObtiene el hash de contenido SHA1 de este adjunto.
getName()StringObtiene el nombre de este blob.
getSize()IntegerObtiene el tamaño de este adjunto.
isGoogleType()BooleanDevuelve si este blob es un archivo de Google Workspace (Hojas de cálculo, Documentos, etcétera).
setBytes(data)BlobEstablece los datos almacenados en este blob.
setContentType(contentType)BlobEstablece el tipo de contenido de los bytes en este BLOB.
setContentTypeFromExtension()BlobEstablece el tipo de contenido de los bytes en este blob según la extensión del archivo.
setDataFromString(string)BlobEstablece los datos de este blob a partir de una cadena con codificación UTF-8.
setDataFromString(string, charset)BlobEstablece los datos de este blob a partir de una cadena con la codificación especificada.
setName(name)BlobEstablece el nombre de este blob.

GmailDraft

Métodos

MétodoTipo de datos que se muestraDescripción breve
deleteDraft()voidBorra este borrador de mensaje.
getId()StringObtiene el ID de este mensaje de borrador.
getMessage()GmailMessageDevuelve un objeto GmailMessage que representa este borrador.
getMessageId()StringDevuelve el ID del GmailMessage que representa este borrador.
send()GmailMessageEnvía este mensaje de correo electrónico en borrador.
update(recipient, subject, body)GmailDraftReemplaza el contenido de este mensaje de borrador.
update(recipient, subject, body, options)GmailDraftReemplaza el contenido de este borrador de mensaje con argumentos opcionales.

GmailLabel

Métodos

MétodoTipo de datos que se muestraDescripción breve
addToThread(thread)GmailLabelAgrega esta etiqueta al subproceso determinado y fuerza la actualización del subproceso (GmailThread.refresh()).
addToThreads(threads)GmailLabelAgrega esta etiqueta a los subprocesos determinados y los obliga a actualizarse.
deleteLabel()voidBorra esta etiqueta.
getId()StringObtiene el ID de esta etiqueta.
getName()StringObtiene 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()IntegerObtiene la cantidad de subprocesos no leídos etiquetados con esta etiqueta.
removeFromThread(thread)GmailLabelQuita esta etiqueta del subproceso determinado y fuerza la actualización del subproceso.
removeFromThreads(threads)GmailLabelQuita esta etiqueta de los subprocesos determinados y los obliga a actualizarse.

GmailMessage

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 usando 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 con la dirección de respuesta y todos los destinatarios de este mensaje.
createDraftReplyAll(body, options)GmailDraftCrea 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)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 incluidos en el campo Cco de este mensaje.
getBody()StringObtiene el contenido HTML del cuerpo de este mensaje.
getCc()StringObtiene los destinatarios separados por comas que se incluyeron en la copia 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 dado 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, el remitente).
getSubject()StringObtiene el asunto de este mensaje.
getThread()GmailThreadObtiene el subproceso que contiene este mensaje.
getTo()StringObtiene los destinatarios de este mensaje separados por comas.
isDraft()BooleanObtiene si este mensaje es un borrador.
isInChats()BooleanObtiene si este mensaje es un chat.
isInInbox()BooleanIndica si este mensaje está en la bandeja de entrada.
isInPriorityInbox()BooleanDevuelve true si este mensaje está en la bandeja de entrada prioritaria; de lo contrario, devuelve false.
isInTrash()BooleanObtiene si este mensaje está en la papelera.
isStarred()BooleanObtiene si este mensaje está destacado.
isUnread()BooleanObtiene si este mensaje no se leyó.
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 de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
reply(body)GmailMessageResponde al remitente de este mensaje usando 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 usando la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
star()GmailMessageDestaca el mensaje.
unstar()GmailMessageQuita el mensaje de la lista de destacados.

GmailThread

Métodos

MétodoTipo de datos que se muestraDescripción breve
addLabel(label)GmailThreadAgrega esta etiqueta al hilo.
createDraftReply(body)GmailDraftCrea un borrador de mensaje para responder al remitente del último mensaje de este subproceso con la dirección de respuesta.
createDraftReply(body, options)GmailDraftCrea 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)GmailDraftCrea 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)GmailDraftCrea 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()StringObtiene el asunto del primer mensaje de la conversación.
getId()StringObtiene el ID de este subproceso.
getLabels()GmailLabel[]Devuelve las etiquetas creadas por el usuario en este subproceso.
getLastMessageDate()DateObtiene la fecha del mensaje más reciente de este hilo.
getMessageCount()IntegerDevuelve la cantidad de mensajes en el subproceso.
getMessages()GmailMessage[]Obtiene los mensajes de este subproceso.
getPermalink()StringObtiene un vínculo permanente para este hilo.
hasStarredMessages()BooleanDevuelve un valor que indica si el hilo tiene mensajes destacados.
isImportant()BooleanDevuelve si el subproceso está marcado como importante.
isInChats()BooleanDevuelve si el subproceso está etiquetado como chat.
isInInbox()BooleanDevuelve un valor que indica si el subproceso está en la carpeta Recibidos.
isInPriorityInbox()BooleanDevuelve verdadero si este subproceso está en la bandeja de entrada prioritaria; de lo contrario, devuelve falso.
isInSpam()BooleanDevuelve si el hilo está marcado como spam.
isInTrash()BooleanDevuelve un valor que indica si el subproceso está en la papelera.
isUnread()BooleanDevuelve un valor que indica si el subproceso tiene mensajes no leídos.
markImportant()GmailThreadMarca este hilo como importante.
markRead()GmailThreadMarca este hilo como leído.
markUnimportant()GmailThreadMarca este hilo como no importante.
markUnread()GmailThreadMarca este hilo como no leído.
moveToArchive()GmailThreadMueve este subproceso al archivo.
moveToInbox()GmailThreadMueve este hilo a la carpeta Recibidos.
moveToSpam()GmailThreadMueve este hilo a la carpeta de spam.
moveToTrash()GmailThreadMueve este hilo a la papelera.
refresh()GmailThreadVuelve 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)GmailThreadQuita esta etiqueta del hilo.
reply(body)GmailThreadResponde al remitente del último mensaje de este hilo con la dirección replyTo.
reply(body, options)GmailThreadResponde al remitente del último mensaje de este hilo con la dirección replyTo, con argumentos opcionales.
replyAll(body)GmailThreadResponder al remitente (con la dirección replyTo) y a todos los destinatarios del último mensaje de este hilo
replyAll(body, options)GmailThreadResponde al remitente (con la dirección replyTo) y a todos los destinatarios del último mensaje de este hilo, con argumentos opcionales.