- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Pruébala
Enumera los mensajes en el buzón del usuario.
Solicitud HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
userId |
La dirección de correo electrónico del usuario. Se puede usar el valor especial |
Parámetros de consulta
Parámetros | |
---|---|
maxResults |
Cantidad máxima de mensajes que se mostrarán. El valor predeterminado de este campo es 100. El valor máximo permitido para este campo es 500. |
pageToken |
Token de página para recuperar una página específica de resultados en la lista. |
q |
Solo muestra mensajes que coinciden con la consulta especificada. Admite el mismo formato de consulta que el cuadro de búsqueda de Gmail. Por ejemplo, |
labelIds[] |
Solo muestra mensajes con etiquetas que coincidan con todos los ID de etiquetas especificados. Es posible que los mensajes de una conversación tengan etiquetas que no tienen otros mensajes de la misma conversación. Para obtener más información, consulta Cómo administrar etiquetas en los mensajes y las conversaciones. |
includeSpamTrash |
Incluye los mensajes de |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"messages": [
{
object ( |
Campos | |
---|---|
messages[] |
Lista de mensajes. Ten en cuenta que cada recurso de mensaje contiene solo un |
nextPageToken |
Token para recuperar la página siguiente de resultados de la lista. |
resultSizeEstimate |
Cantidad total estimada de resultados. |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
Para obtener más información, consulta la guía de autorización.