Method: users.messages.list

Muestra una lista de los mensajes del 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

string

La dirección de correo electrónico del usuario. Se puede usar el valor especial me para indicar el usuario autenticado.

Parámetros de consulta

Parámetros
maxResults

integer (uint32 format)

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

string

Token de la página para recuperar una página específica de resultados en la lista.
q

string

Solo mostrar mensajes que coincidan con la consulta especificada Admite el mismo formato de consulta que el cuadro de búsqueda de Gmail. Por ejemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". El parámetro no se puede usar cuando se accede a la API con el permiso gmail.metadata.
labelIds[]

string

Mostrar solo los mensajes con etiquetas que coincidan con todos los IDs de etiqueta especificados. Es posible que los mensajes de una conversación tengan etiquetas que otros mensajes de la misma conversación no tengan. Para obtener más información, consulta Cómo administrar etiquetas en los mensajes y conversaciones.
includeSpamTrash

boolean

Incluye mensajes de SPAM y TRASH en los resultados.

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 (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Campos
messages[]

object (Message)

Lista de mensajes. Ten en cuenta que cada recurso de mensaje contiene solo un id y un threadId. Los detalles adicionales de los mensajes se pueden recuperar con el método messages.get.
nextPageToken

string

Token para recuperar la página siguiente de resultados en la lista.
resultSizeEstimate

integer (uint32 format)

Cantidad total estimada de resultados.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.