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

NombreDescripción breve
GmailAppProporciona acceso a las conversaciones, los mensajes y las etiquetas de Gmail.
GmailAttachmentUn archivo adjunto de Gmail
GmailDraftUn borrador de mensaje creado por un usuario en la cuenta de Gmail de un usuario.
GmailLabelUna etiqueta creada por un usuario en la cuenta de Gmail de un usuario.
GmailMessageUn mensaje en la Cuenta de Gmail de un usuario.
GmailThreadUna conversación 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 nueva etiqueta de usuario con el nombre dado.
deleteLabel(label)GmailAppBorra la etiqueta especificada.
getAliases()String[]Obtiene una lista de los correos electrónicos configurados como alias de esta cuenta en Gmail.
getDraft(draftId)GmailDraftRecupera 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()IntegerObtiene la cantidad de conversaciones no leídas en la bandeja de entrada.
getMessageById(id)GmailMessageObtiene 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()IntegerObtiene 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()IntegerObtiene 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()IntegerObtiene la cantidad de conversaciones no leídas que están destacadas.
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 sin importar las etiquetas.
getUserLabelByName(name)GmailLabelRecupera una etiqueta según su nombre.
getUserLabels()GmailLabel[]Recupera una lista de etiquetas creadas por el usuario.
markMessageRead(message)GmailAppMarca este mensaje como leído y lo obliga a actualizarse.
markMessageUnread(message)GmailAppMarca este mensaje como no leído y lo fuerza a actualizarse.
markMessagesRead(messages)GmailAppMarca estos mensajes como leídos y fuerza su actualización.
markMessagesUnread(messages)GmailAppMarca estos mensajes como no leídos y fuerza su actualización.
markThreadImportant(thread)GmailAppMarca esta conversación como importante y fuerza su actualización.
markThreadRead(thread)GmailAppMarca esta conversación como leída y fuerza su actualización.
markThreadUnimportant(thread)GmailAppMarca esta conversación como no importante y fuerza su actualización.
markThreadUnread(thread)GmailAppMarca esta conversación como no leída y fuerza a su actualización.
markThreadsImportant(threads)GmailAppMarca estas conversaciones como importantes y fuerza su actualización.
markThreadsRead(threads)GmailAppMarca estos subprocesos como leídos y fuerza su actualización.
markThreadsUnimportant(threads)GmailAppMarca estas conversaciones como no importantes y fuerza su actualización.
markThreadsUnread(threads)GmailAppMarca estas conversaciones como no leídas y fuerza a que se actualicen.
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 esta conversación al archivo y fuerza su actualización.
moveThreadToInbox(thread)GmailAppMueve esta conversación a Recibidos y fuerza su actualización.
moveThreadToSpam(thread)GmailAppMueve esta conversación a Spam y fuerza su actualización.
moveThreadToTrash(thread)GmailAppMueve esta conversación a la papelera y fuerza su actualización.
moveThreadsToArchive(threads)GmailAppMueve estos subprocesos al archivo y fuerza su actualización.
moveThreadsToInbox(threads)GmailAppMueve estas conversaciones a Recibidos y fuerza su actualización.
moveThreadsToSpam(threads)GmailAppMueve estas conversaciones a Spam y fuerza su actualización.
moveThreadsToTrash(threads)GmailAppMueve estas conversaciones a la papelera y fuerza su actualización.
refreshMessage(message)GmailAppVuelve 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)GmailAppVuelve 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)GmailAppVuelve 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)GmailAppVuelve 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)GmailAppEnvía un mensaje de correo electrónico.
sendEmail(recipient, subject, body, options)GmailAppEnvía un 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 actuales de GmailMessage.
starMessage(message)GmailAppDestaca este mensaje con una estrella y lo obliga a actualizarse.
starMessages(messages)GmailAppDestaca con una estrella 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()BlobMuestra una copia de este BLOB.
getAs(contentType)BlobMuestra 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 de este BLOB.
getDataAsString()StringObtiene los datos de este BLOB como una string con codificación UTF-8.
getDataAsString(charset)StringObtiene los datos de este BLOB como una string con la codificación especificada.
getHash()StringObtiene el hash de contenido SHA1 para este archivo adjunto.
getName()StringObtiene el nombre de este BLOB.
getSize()IntegerObtiene el tamaño de este archivo adjunto.
isGoogleType()BooleanMuestra si este BLOB es un archivo de Google Workspace (Hojas de cálculo, Documentos, etcétera).
setBytes(data)BlobConfigura los datos almacenados en este BLOB.
setContentType(contentType)BlobConfigura 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 de archivo.
setDataFromString(string)BlobConfigura los datos de este BLOB a partir de una string con codificación UTF-8.
setDataFromString(string, charset)BlobConfigura los datos de este BLOB a partir de una string 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()voidElimina este borrador del mensaje.
getId()StringObtiene el ID de este borrador de mensaje.
getMessage()GmailMessageMuestra un GmailMessage que representa este borrador.
getMessageId()StringMuestra el ID de la GmailMessage que representa a este borrador.
send()GmailMessageSe envía este borrador de correo electrónico.
update(recipient, subject, body)GmailDraftReemplaza el contenido de este borrador de mensaje.
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 su actualización (GmailThread.refresh()).
addToThreads(threads)GmailLabelAgrega esta etiqueta a los subprocesos determinados y fuerza la actualización de estos.
deleteLabel()voidBorra esta etiqueta.
getName()StringObtiene 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()IntegerObtiene la cantidad de conversaciones no leídas que se etiquetaron con esta etiqueta.
removeFromThread(thread)GmailLabelQuita esta etiqueta del subproceso en cuestión y fuerza su actualización.
removeFromThreads(threads)GmailLabelQuita esta etiqueta de los subprocesos determinados y fuerza la actualización de estos.

GmailMessage

Métodos

MétodoTipo de datos que se muestraDescripción breve
createDraftReply(body)GmailDraftCrea un borrador para responder al remitente del mensaje utilizando la dirección de respuesta.
createDraftReply(body, options)GmailDraftCrea un borrador de mensaje para responder al remitente mediante 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 del mensaje.
createDraftReplyAll(body, options)GmailDraftCrea 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)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 que se incluyeron 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 incluyen en el campo Cc de este mensaje.
getDate()DateObtiene la fecha y hora de este mensaje.
getFrom()StringObtiene el remitente de este mensaje.
getHeader(name)StringObtiene el valor de un encabezado RFC 2822 según 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 la conversación 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()BooleanObtiene si este mensaje está en la carpeta Recibidos.
isInPriorityInbox()BooleanMuestra true si este mensaje está en la bandeja de entrada Prioritarios; de lo contrario, muestra false.
isInTrash()BooleanObtiene si el mensaje está en la papelera.
isStarred()BooleanObtiene si este mensaje está destacado.
isUnread()BooleanObtiene si este mensaje está no leído.
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 desde Gmail (es útil en caso de que las etiquetas, el estado de lectura, etc. hayan cambiado).
reply(body)GmailMessageResponde al remitente de este mensaje con la dirección de respuesta.
reply(body, options)GmailMessageResponde al remitente de este mensaje con la dirección de respuesta, con argumentos opcionales.
replyAll(body)GmailMessageResponde al remitente con la dirección de respuesta y a todos los destinatarios del mensaje.
replyAll(body, options)GmailMessageResponde al remitente de este mensaje con la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
star()GmailMessageDestaca el mensaje.
unstar()GmailMessageDeja de destacar el mensaje.

GmailThread

Métodos

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