Gmail API

La API de Gmail te permite ver y administrar los datos del buzón de Gmail, como hilos, mensajes y etiquetas.

Servicio: gmail.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la información siguiente cuando realices las solicitudes a la API.

Documento de descubrimiento

Un Documento de descubrimiento es una especificación procesable para describir y consumir las API de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona el documento de descubrimiento siguiente:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de la red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://gmail.googleapis.com

Recurso de REST: v1.users

Métodos
getProfile GET /gmail/v1/users/{userId}/profile
Obtiene el perfil de Gmail del usuario actual.
stop POST /gmail/v1/users/{userId}/stop
Desactiva la entrega de notificaciones push para el buzón de correo del usuario determinado.
watch POST /gmail/v1/users/{userId}/watch
Configura o actualiza una observación de notificaciones push en el buzón de correo del usuario determinado.

Recurso de REST: v1.users.drafts

Métodos
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Crea un borrador con la etiqueta DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Borra de inmediato y de forma permanente el borrador especificado.
get GET /gmail/v1/users/{userId}/drafts/{id}
Obtiene el borrador especificado.
list GET /gmail/v1/users/{userId}/drafts
Enumera los borradores en el buzón del usuario.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Envía el borrador existente especificado a los destinatarios en los encabezados To, Cc y Bcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Reemplaza el contenido de un borrador.

Recurso de REST: v1.users.history

Métodos
list GET /gmail/v1/users/{userId}/history
Enumera el historial de todos los cambios realizados en el buzón de correo determinado.

Recurso de REST: v1.users.labels

Métodos
create POST /gmail/v1/users/{userId}/labels
Crea una etiqueta.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Borra de forma inmediata y permanente la etiqueta especificada, y la quita de los mensajes y los subprocesos a los que se aplicó.
get GET /gmail/v1/users/{userId}/labels/{id}
Obtiene la etiqueta especificada.
list GET /gmail/v1/users/{userId}/labels
Enumera todas las etiquetas del buzón de correo del usuario.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Aplica parches a la etiqueta especificada.
update PUT /gmail/v1/users/{userId}/labels/{id}
Actualiza la etiqueta especificada.

Recurso de REST: v1.users.messages

Métodos
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Borra muchos mensajes por ID.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Modifica las etiquetas de los mensajes especificados.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Borra de forma inmediata y permanente el mensaje especificado.
get GET /gmail/v1/users/{userId}/messages/{id}
Obtiene el mensaje especificado.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Importa un mensaje solo a la casilla de correo de este usuario, con la clasificación y el análisis de entrega de correo electrónico estándar similares a los de la recepción a través de SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Inserta directamente un mensaje solo en el buzón de correo de este usuario de forma similar a IMAP APPEND, y omite la mayoría de los análisis y clasificaciones.
list GET /gmail/v1/users/{userId}/messages
Enumera los mensajes en el buzón del usuario.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Modifica las etiquetas del mensaje especificado.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Envía el mensaje especificado a los destinatarios en los encabezados To, Cc y Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Mueve el mensaje especificado a la papelera.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Quita el mensaje especificado de la papelera.

Recurso de REST: v1.users.messages.attachments

Métodos
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Obtiene el archivo adjunto del mensaje especificado.

Recurso de REST: v1.users.settings

Métodos
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Obtiene el parámetro de configuración de reenvío automático para la cuenta especificada.
getImap GET /gmail/v1/users/{userId}/settings/imap
Obtiene la configuración de IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Obtiene la configuración de idioma.
getPop GET /gmail/v1/users/{userId}/settings/pop
Obtiene la configuración de POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Obtiene la configuración de la respuesta automática.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Actualiza el parámetro de configuración de reenvío automático para la cuenta especificada.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Actualiza la configuración de IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Actualiza la configuración de idioma.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Actualiza la configuración de POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Actualiza la configuración de la respuesta automática.

Recurso de REST: v1.users.settings.cse.identities

Métodos
create POST /gmail/v1/users/{userId}/settings/cse/identities
Crea y configura una identidad de encriptación del cliente autorizada para enviar correos desde la cuenta de usuario.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Borra una identidad de encriptación del cliente.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Recupera una configuración de identidad de encriptación del cliente.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Enumera las identidades encriptadas del cliente para un usuario autenticado.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Asocia un par de claves diferente con una identidad de encriptación del cliente existente.

Recurso de REST: v1.users.settings.cse.keypairs

Métodos
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Crea y sube una cadena de certificados de clave pública S/MIME de encriptación del cliente y metadatos de clave privada para el usuario autenticado.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Desactiva un par de claves de encriptación del cliente.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Activa un par de claves de encriptación del cliente que se había desactivado.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Recupera un par de claves de encriptación del cliente existente.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Enumera los pares de claves de encriptación del cliente para un usuario autenticado.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Borra un par de claves de encriptación del cliente de forma permanente e inmediata.

Recurso de REST: v1.users.settings.delegates

Métodos
create POST /gmail/v1/users/{userId}/settings/delegates
Agrega un delegado con su estado de verificación establecido directamente en accepted, sin enviar ningún correo electrónico de verificación.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Quita el delegado especificado (que puede tener cualquier estado de verificación) y revoca cualquier verificación que se haya requerido para usarlo.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Obtiene el delegado especificado.
list GET /gmail/v1/users/{userId}/settings/delegates
Enumera los delegados de la cuenta especificada.

Recurso de REST: v1.users.settings.filters

Métodos
create POST /gmail/v1/users/{userId}/settings/filters
Crea un filtro.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Borra de inmediato y de forma permanente el filtro especificado.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Obtiene un filtro.
list GET /gmail/v1/users/{userId}/settings/filters
Enumera los filtros de mensajes de un usuario de Gmail.

Recurso de REST: v1.users.settings.forwardingAddresses

Métodos
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Crea una dirección de reenvío.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Borra la dirección de reenvío especificada y revoca cualquier verificación que se haya requerido.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Obtiene la dirección de reenvío especificada.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Enumera las direcciones de reenvío de la cuenta especificada.

Recurso de REST: v1.users.settings.sendAs

Métodos
create POST /gmail/v1/users/{userId}/settings/sendAs
Crea un alias de envío personalizado "De".
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Borra el alias de enviar como especificado.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Obtiene el alias de enviar como especificado.
list GET /gmail/v1/users/{userId}/settings/sendAs
Enumera los alias de enviar como para la cuenta especificada.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Aplica parches al alias de enviar como especificado.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Actualiza un alias de envío.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Envía un correo electrónico de verificación a la dirección de alias de envío especificada.

Recurso de REST: v1.users.settings.sendAs.smimeInfo

Métodos
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Borra la configuración de S/MIME especificada para el alias de enviar como especificado.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Obtiene la configuración de S/MIME especificada para el alias de enviar como especificado.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Inserta (sube) la configuración de S/MIME proporcionada para el alias de enviar como especificado.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Enumera la configuración de S/MIME para el alias de enviar como especificado.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Establece la configuración predeterminada de S/MIME para el alias de enviar como especificado.

Recurso de REST: v1.users.threads

Métodos
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Borra de inmediato y de forma permanente el subproceso especificado.
get GET /gmail/v1/users/{userId}/threads/{id}
Obtiene el subproceso especificado.
list GET /gmail/v1/users/{userId}/threads
Enumera los subprocesos en el buzón de correo del usuario.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Modifica las etiquetas aplicadas al subproceso.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Mueve el subproceso especificado a la papelera.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Quita el subproceso especificado de la papelera.