Descripción general
Servicios de Google Workspace
Calendar
- Descripción general
- App de Calendario
- Clases
- Calendar
- Evento de calendario
- CalendarEventSeries
- Invitado al evento
- Recurrencia del evento
- Regla de recurrencia
- Enums
- Color
- Color de evento
- EventTransparency
- EventType
- Estado de invitado
- Visibilidad
- Servicios avanzados
- API de Calendar
Documentos
Drive
- Descripción general
- DriveApp
- Clases
- Archivo
- FileIterator
- Carpeta
- Iterador de carpetas
- Usuario
- Enums
- Acceso
- Permiso
- Servicios avanzados
- API de Drive
- Drive Activity API
- Drive Labels API
Formularios
Gmail
- Descripción general
- Aplicación Gmail
- Clases
- Archivo adjunto de Gmail
- Borrador de Gmail
- Etiqueta de Gmail
- Mensaje de Gmail
- Conversación de Gmail
- Servicios avanzados
- API de Gmail
Hojas de cálculo
Presentaciones
Más...
- Grupos
  - Descripción general
  - App de Grupos
  - Clases
  - Group
  - Enums
  - Rol
  - Servicios avanzados
  - API de Groups de Cloud Identity
  - Cómo migrar desde el servicio de Grupos
- Personas
  - Servicios avanzados
  - API de People
  - Cómo migrar desde el servicio de Contactos
  - Contactos
  - Descripción general
  - App de Contactos
  - Clases
  - CampoDirección
  - CampoEmpresa
  - Contacto
  - Grupo de contactos
  - CustomField
  - DateField
  - CampoCorreo electrónico
  - IM.campo
  - CampoTeléfono
  - CampoURLUrl
  - Enums
  - Campo extendido
  - Campo
  - Género
  - Prioridad
  - Sensibilidad
Otros servicios de Google
Google Maps
YouTube
- Servicios avanzados
- API de YouTube Data
- API de YouTube Analytics
- API de Content ID de YouTube
Más...
- Google Ads &Merchant Center
- Google Data Studio
Servicios de servicios públicos
Conexiones de base de datos de API
Usabilidad y optimización de datos
- Optimización
- XML
  - Descripción general
  - Servicio Xml
  - Clases
  - Atributo
  - Cdata
  - Comment
  - Tipo de documento
  - Documento
  - Elemento
  - Referencia de entidad
  - Formato
  - Espacio de nombres
  - ProcessingInstruction
  - Texto
  - Interfaces
  - Contenido
  - Enums
  - ContentType
Contenido &HTML
Información sobre la ejecución de la secuencia de comandos
- Capas
  - Descripción general
  - Navegador
  - Logger
  - Tipo de MIME
  - Sesión
  - Console
  - Clases
  - BLOB
  - Menú
  - Mensaje de respuesta
  - RgbColor
  - IU
  - Usuario
  - Interfaces
  - Fuente BLOB
  - Enums
  - Botón
  - Conjunto de botones
  - Tipo de color
  - Mes
  - Día de semana
- Secuencia de comandos
Recursos del proyecto de secuencia de comandos
Manifiesto
Cuotas y límites
Complementos de Google Workspace
Servicios
Manifiesto
API de complementos
API de Apps Script
v1
- Descripción general
- Recursos de REST
- Tipos
- EjecutarStreamResponse
- ExecutionError
- Respuesta de ejecución
- Archivo
- LocalizedMessage
- NullValue

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 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
`Gmail App`	Proporciona acceso a los hilos, mensajes y etiquetas de Gmail.
`Gmail Attachment`	Es un archivo adjunto de Gmail.
`Gmail Draft`	Es un borrador de mensaje creado por el usuario en su cuenta de Gmail.
`Gmail Label`	Es una etiqueta creada por el usuario en su cuenta de Gmail.
`Gmail Message`	Es un mensaje en la cuenta de Gmail de un usuario.
`Gmail Thread`	Es un hilo en la cuenta de Gmail de un usuario.

`GmailApp`

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`create Draft(recipient, subject, body)`	`Gmail Draft`	Crea un borrador de mensaje de correo electrónico.
`create Draft(recipient, subject, body, options)`	`Gmail Draft`	Crea un borrador de mensaje de correo electrónico con argumentos opcionales.
`create Label(name)`	`Gmail Label`	Crea una etiqueta de usuario nueva con el nombre proporcionado.
`delete Label(label)`	`Gmail App`	Borra la etiqueta especificada.
`get Aliases()`	`String[]`	Obtiene una lista de los correos electrónicos configurados como alias para esta cuenta en Gmail.
`get Draft(draftId)`	`Gmail Draft`	Recupera un borrador de mensaje de correo electrónico por ID.
`get Draft Messages()`	`Gmail Message[]`	Recupera todos los mensajes en borrador.
`get Drafts()`	`Gmail Draft[]`	Obtiene todos los mensajes de borrador de Gmail.
`get Inbox Threads()`	`Gmail Thread[]`	Recupera todos los subprocesos de la bandeja de entrada, independientemente de las etiquetas.
`get Inbox Threads(start, max)`	`Gmail Thread[]`	Recupera un rango de subprocesos de Recibidos, independientemente de las etiquetas.
`get Inbox Unread Count()`	`Integer`	Obtiene la cantidad de hilos no leídos en la carpeta Recibidos.
`get Message By Id(id)`	`Gmail Message`	Obtiene un mensaje por ID.
`get Messages For Thread(thread)`	`Gmail Message[]`	Recupera todos los mensajes de la conversación especificada.
`get Messages For Threads(threads)`	`Gmail Message[][]`	Recupera todos los mensajes de los subprocesos especificados.
`get Priority Inbox Threads()`	`Gmail Thread[]`	Recupera todos los subprocesos de Recibidos prioritarios, independientemente de las etiquetas.
`get Priority Inbox Threads(start, max)`	`Gmail Thread[]`	Recupera un rango de hilos de la bandeja de entrada prioritarios, independientemente de las etiquetas.
`get Priority Inbox Unread Count()`	`Integer`	Obtiene la cantidad de conversaciones no leídas en la carpeta de Recibidos prioritarios.
`get Spam Threads()`	`Gmail Thread[]`	Recupera todos los subprocesos de spam, independientemente de las etiquetas.
`get Spam Threads(start, max)`	`Gmail Thread[]`	Recupera un rango de subprocesos de spam, independientemente de las etiquetas.
`get Spam Unread Count()`	`Integer`	Obtiene la cantidad de hilos no leídos que son spam.
`get Starred Threads()`	`Gmail Thread[]`	Recupera todos los subprocesos destacados, independientemente de las etiquetas.
`get Starred Threads(start, max)`	`Gmail Thread[]`	Recupera un rango de conversaciones destacadas, independientemente de las etiquetas.
`get Starred Unread Count()`	`Integer`	Obtiene la cantidad de conversaciones no leídas que se marcaron con una estrella.
`get Thread By Id(id)`	`Gmail Thread\|null`	Obtiene un subproceso por ID.
`get Trash Threads()`	`Gmail Thread[]`	Recupera todos los subprocesos de la papelera, independientemente de las etiquetas.
`get Trash Threads(start, max)`	`Gmail Thread[]`	Recupera un rango de subprocesos de la papelera, independientemente de las etiquetas.
`get User Label By Name(name)`	`Gmail Label`	Recupera una etiqueta según su nombre.
`get User Labels()`	`Gmail Label[]`	Recupera una lista de las etiquetas creadas por el usuario.
`mark Message Read(message)`	`Gmail App`	Marca este mensaje como leído y fuerza su actualización.
`mark Message Unread(message)`	`Gmail App`	Marca este mensaje como no leído y fuerza su actualización.
`mark Messages Read(messages)`	`Gmail App`	Marca estos mensajes como leídos y fuerza la actualización de los mensajes.
`mark Messages Unread(messages)`	`Gmail App`	Marca estos mensajes como no leídos y fuerza la actualización de los mensajes.
`mark Thread Important(thread)`	`Gmail App`	Marca este hilo como importante y fuerza su actualización.
`mark Thread Read(thread)`	`Gmail App`	Marca este hilo como leído y fuerza su actualización.
`mark Thread Unimportant(thread)`	`Gmail App`	Marca este hilo como no importante y fuerza su actualización.
`mark Thread Unread(thread)`	`Gmail App`	Marca este hilo como no leído y fuerza su actualización.
`mark Threads Important(threads)`	`Gmail App`	Marca estos subprocesos como importantes y los obliga a actualizarse.
`mark Threads Read(threads)`	`Gmail App`	Marca estos hilos como leídos y los obliga a actualizarse.
`mark Threads Unimportant(threads)`	`Gmail App`	Marca estos hilos como no importantes y fuerza la actualización de los hilos.
`mark Threads Unread(threads)`	`Gmail App`	Marca estos hilos como no leídos y los obliga a actualizarse.
`move Message To Trash(message)`	`Gmail App`	Mueve el mensaje a la papelera y fuerza la actualización del mensaje.
`move Messages To Trash(messages)`	`Gmail App`	Mueve los mensajes especificados a la papelera y fuerza la actualización de los mensajes.
`move Thread To Archive(thread)`	`Gmail App`	Mueve este subproceso al archivo y fuerza su actualización.
`move Thread To Inbox(thread)`	`Gmail App`	Mueve este subproceso a la bandeja de entrada y fuerza su actualización.
`move Thread To Spam(thread)`	`Gmail App`	Mueve este hilo a spam y fuerza la actualización del hilo.
`move Thread To Trash(thread)`	`Gmail App`	Mueve este subproceso a la papelera y fuerza su actualización.
`move Threads To Archive(threads)`	`Gmail App`	Mueve estos hilos al archivo y fuerza la actualización de los hilos.
`move Threads To Inbox(threads)`	`Gmail App`	Mueve estos hilos a la bandeja de entrada y los obliga a actualizarse.
`move Threads To Spam(threads)`	`Gmail App`	Mueve estos hilos a spam y los obliga a actualizarse.
`move Threads To Trash(threads)`	`Gmail App`	Mueve estos hilos a la papelera y los obliga a actualizarse.
`refresh Message(message)`	`Gmail App`	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.).
`refresh Messages(messages)`	`Gmail App`	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).
`refresh Thread(thread)`	`Gmail App`	Vuelve a cargar el subproceso y el estado asociado de Gmail (útil en caso de que hayan cambiado las etiquetas, el estado de lectura, etcétera).
`refresh Threads(threads)`	`Gmail App`	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)`	`Gmail Thread[]`	Busca en Gmail con la consulta proporcionada.
`search(query, start, max)`	`Gmail Thread[]`	Busca en Gmail con la consulta proporcionada.
`send Email(recipient, subject, body)`	`Gmail App`	Envía un mensaje de correo electrónico.
`send Email(recipient, subject, body, options)`	`Gmail App`	Envía un mensaje de correo electrónico con argumentos opcionales.
`set Current Message Access Token(accessToken)`	`void`	Establece el token de acceso del mensaje actual que permite que la secuencia de comandos acceda a las propiedades de `Gmail Message` actuales.
`star Message(message)`	`Gmail App`	Agrega una estrella a este mensaje y lo obliga a actualizarse.
`star Messages(messages)`	`Gmail App`	Agrega estrellas a estos mensajes y los obliga a actualizarse.
`unstar Message(message)`	`Gmail App`	Quita la estrella de este mensaje y fuerza su actualización.
`unstar Messages(messages)`	`Gmail App`	Quita las estrellas de estos mensajes y los obliga a actualizarse.

`GmailAttachment`

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`copy Blob()`	`Blob`	Devuelve una copia de este BLOB.
`get As(contentType)`	`Blob`	Devuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
`get Bytes()`	`Byte[]`	Obtiene los datos almacenados en este blob.
`get Content Type()`	`String\|null`	Obtiene el tipo de contenido de los bytes en este BLOB.
`get Data As String()`	`String`	Obtiene los datos de este BLOB como una cadena con codificación UTF-8.
`get Data As String(charset)`	`String`	Obtiene los datos de este BLOB como una cadena con la codificación especificada.
`get Hash()`	`String`	Obtiene el hash de contenido SHA1 de este adjunto.
`get Name()`	`String\|null`	Obtiene el nombre de este blob.
`get Size()`	`Integer`	Obtiene el tamaño de este adjunto.
`is Google Type()`	`Boolean`	Devuelve si este BLOB es un archivo de Google Workspace (Hojas de cálculo, Documentos, etcétera).
`set Bytes(data)`	`Blob`	Establece los datos almacenados en este blob.
`set Content Type(contentType)`	`Blob`	Establece el tipo de contenido de los bytes en este BLOB.
`set Content Type From Extension()`	`Blob`	Establece el tipo de contenido de los bytes en este blob según la extensión del archivo.
`set Data From String(string)`	`Blob`	Establece los datos de este BLOB a partir de una cadena con codificación UTF-8.
`set Data From String(string, charset)`	`Blob`	Establece los datos de este blob a partir de una cadena con la codificación especificada.
`set Name(name)`	`Blob`	Establece el nombre de este blob.

`GmailDraft`

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`delete Draft()`	`void`	Borra este borrador de mensaje.
`get Id()`	`String`	Obtiene el ID de este mensaje de borrador.
`get Message()`	`Gmail Message`	Devuelve un GmailMessage que representa este borrador.
`get Message Id()`	`String`	Devuelve el ID del `Gmail Message` que representa este borrador.
`send()`	`Gmail Message`	Envía este mensaje de correo electrónico en borrador.
`update(recipient, subject, body)`	`Gmail Draft`	Reemplaza el contenido de este mensaje de borrador.
`update(recipient, subject, body, options)`	`Gmail Draft`	Reemplaza el contenido de este borrador de mensaje con argumentos opcionales.

`GmailLabel`

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`add To Thread(thread)`	`Gmail Label`	Agrega esta etiqueta al subproceso determinado y fuerza la actualización del subproceso (`Gmail Thread.refresh()`).
`add To Threads(threads)`	`Gmail Label`	Agrega esta etiqueta a los subprocesos determinados y los obliga a actualizarse.
`delete Label()`	`void`	Borra esta etiqueta.
`get Id()`	`String`	Obtiene el ID de esta etiqueta.
`get Name()`	`String`	Obtiene el nombre de esta etiqueta.
`get Threads()`	`Gmail Thread[]`	Obtiene los subprocesos marcados con esta etiqueta.
`get Threads(start, max)`	`Gmail Thread[]`	Obtiene un rango de subprocesos marcados con esta etiqueta.
`get Unread Count()`	`Integer`	Obtiene la cantidad de subprocesos no leídos etiquetados con esta etiqueta.
`remove From Thread(thread)`	`Gmail Label`	Quita esta etiqueta del subproceso determinado y fuerza la actualización del subproceso.
`remove From Threads(threads)`	`Gmail Label`	Quita esta etiqueta de los subprocesos determinados y los obliga a actualizarse.

`GmailMessage`

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`create Draft Reply(body)`	`Gmail Draft`	Crea un mensaje de borrador para responder al remitente de este mensaje usando la dirección de respuesta.
`create Draft Reply(body, options)`	`Gmail Draft`	Crea un borrador de mensaje para responder al remitente de este mensaje usando la dirección de respuesta, con argumentos opcionales.
`create Draft Reply All(body)`	`Gmail Draft`	Crea un borrador de mensaje para responder al remitente usando la dirección de respuesta y todos los destinatarios de este mensaje.
`create Draft Reply All(body, options)`	`Gmail Draft`	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)`	`Gmail Message`	Reenvía este mensaje a nuevos destinatarios.
`forward(recipient, options)`	`Gmail Message`	Reenvía este mensaje a nuevos destinatarios, con argumentos opcionales.
`get Attachments()`	`Gmail Attachment[]`	Obtiene todos los archivos adjuntos de este mensaje.
`get Attachments(options)`	`Gmail Attachment[]`	Obtiene todos los archivos adjuntos de este mensaje.
`get Bcc()`	`String`	Obtiene los destinatarios separados por comas que se incluyeron en Cco en este mensaje.
`get Body()`	`String`	Obtiene el contenido HTML del cuerpo de este mensaje.
`get Cc()`	`String`	Obtiene los destinatarios separados por comas que se incluyeron en Cc en este mensaje.
`get Date()`	`Date`	Obtiene la fecha y la hora de este mensaje.
`get From()`	`String`	Obtiene el remitente de este mensaje.
`get Header(name)`	`String`	Obtiene el valor de un encabezado RFC 2822 dado el nombre del encabezado.
`get Id()`	`String`	Obtiene el ID de este mensaje.
`get Plain Body()`	`String`	Obtiene el contenido del cuerpo de este mensaje sin formato HTML.
`get Raw Content()`	`String`	Obtiene el contenido sin procesar de este mensaje.
`get Reply To()`	`String`	Obtiene la dirección de respuesta de este mensaje (por lo general, el remitente).
`get Subject()`	`String`	Obtiene el asunto de este mensaje.
`get Thread()`	`Gmail Thread`	Obtiene el subproceso que contiene este mensaje.
`get To()`	`String`	Obtiene los destinatarios de este mensaje separados por comas.
`is Draft()`	`Boolean`	Indica si este mensaje es un borrador.
`is In Chats()`	`Boolean`	Obtiene si este mensaje es un chat.
`is In Inbox()`	`Boolean`	Indica si este mensaje está en la bandeja de entrada.
`is In Priority Inbox()`	`Boolean`	Devuelve `true` si este mensaje está en la bandeja de entrada prioritaria; de lo contrario, devuelve `false`.
`is In Trash()`	`Boolean`	Obtiene un valor que indica si este mensaje está en la papelera.
`is Starred()`	`Boolean`	Obtiene si este mensaje está destacado.
`is Unread()`	`Boolean`	Obtiene si este mensaje no se leyó.
`mark Read()`	`Gmail Message`	Marca el mensaje como leído.
`mark Unread()`	`Gmail Message`	Marca el mensaje como no leído.
`move To Trash()`	`Gmail Message`	Mueve el mensaje a la papelera.
`refresh()`	`Gmail Message`	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)`	`Gmail Message`	Responde al remitente de este mensaje usando la dirección de respuesta.
`reply(body, options)`	`Gmail Message`	Responde al remitente de este mensaje usando la dirección de respuesta, con argumentos opcionales.
`reply All(body)`	`Gmail Message`	Responde al remitente con la dirección de respuesta y a todos los destinatarios de este mensaje.
`reply All(body, options)`	`Gmail Message`	Responde al remitente de este mensaje usando la dirección de respuesta y todos los destinatarios, con argumentos opcionales.
`star()`	`Gmail Message`	Destaca el mensaje.
`unstar()`	`Gmail Message`	Deja de destacar el mensaje.

`GmailThread`

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`add Label(label)`	`Gmail Thread`	Agrega esta etiqueta al hilo.
`create Draft Reply(body)`	`Gmail Draft`	Crea un borrador de mensaje para responder al remitente del último mensaje de este subproceso con la dirección de respuesta.
`create Draft Reply(body, options)`	`Gmail Draft`	Crea un borrador de mensaje para responder al remitente del último mensaje de este subproceso con la dirección de respuesta, con argumentos opcionales.
`create Draft Reply All(body)`	`Gmail Draft`	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.
`create Draft Reply All(body, options)`	`Gmail Draft`	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.
`get First Message Subject()`	`String`	Obtiene el asunto del primer mensaje de la conversación.
`get Id()`	`String`	Obtiene el ID de este subproceso.
`get Labels()`	`Gmail Label[]`	Devuelve las etiquetas creadas por el usuario en este subproceso.
`get Last Message Date()`	`Date`	Obtiene la fecha del mensaje más reciente de este debate.
`get Message Count()`	`Integer`	Devuelve la cantidad de mensajes del subproceso.
`get Messages()`	`Gmail Message[]`	Obtiene los mensajes de este hilo.
`get Permalink()`	`String`	Obtiene un vínculo permanente para este hilo.
`has Starred Messages()`	`Boolean`	Devuelve un valor que indica si el hilo tiene mensajes destacados.
`is Important()`	`Boolean`	Devuelve si el hilo está marcado como importante.
`is In Chats()`	`Boolean`	Devuelve si el subproceso está etiquetado como chat.
`is In Inbox()`	`Boolean`	Devuelve un valor que indica si el subproceso está en la carpeta Recibidos.
`is In Priority Inbox()`	`Boolean`	Devuelve verdadero si este hilo está en la bandeja de entrada prioritaria; de lo contrario, devuelve falso.
`is In Spam()`	`Boolean`	Devuelve si el hilo se marcó como spam.
`is In Trash()`	`Boolean`	Devuelve un valor que indica si el subproceso está en la papelera.
`is Unread()`	`Boolean`	Devuelve un valor que indica si el subproceso tiene mensajes no leídos.
`mark Important()`	`Gmail Thread`	Marca este hilo como importante.
`mark Read()`	`Gmail Thread`	Marca este hilo como leído.
`mark Unimportant()`	`Gmail Thread`	Marca este hilo como no importante.
`mark Unread()`	`Gmail Thread`	Marca este hilo como no leído.
`move To Archive()`	`Gmail Thread`	Mueve este hilo al archivo.
`move To Inbox()`	`Gmail Thread`	Mueve este hilo a la carpeta Recibidos.
`move To Spam()`	`Gmail Thread`	Mueve este hilo a la carpeta de spam.
`move To Trash()`	`Gmail Thread`	Mueve este hilo a la papelera.
`refresh()`	`Gmail Thread`	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.).
`remove Label(label)`	`Gmail Thread`	Quita esta etiqueta del hilo.
`reply(body)`	`Gmail Thread`	Responde al remitente del último mensaje de este hilo con la dirección replyTo.
`reply(body, options)`	`Gmail Thread`	Responde al remitente del último mensaje de este hilo con la dirección replyTo, con argumentos opcionales.
`reply All(body)`	`Gmail Thread`	Responder al remitente (con la dirección replyTo) y a todos los destinatarios del último mensaje de este hilo
`reply All(body, options)`	`Gmail Thread`	Responde al remitente (con la dirección `reply To`) y a todos los destinatarios del último mensaje de este hilo, con argumentos opcionales.

Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.

Última actualización: 2026-04-13 (UTC)