Method: users.messages.list

Enumera los mensajes de la casilla de correo del usuario. Para ver un ejemplo de uso, consulta Cómo enumerar mensajes de Gmail.

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)

Es la cantidad máxima de mensajes que se devolverán. El valor predeterminado de este campo es 100. El valor máximo permitido para este campo es 500.
pageToken

string

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

string

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

string

Solo devuelve los mensajes con etiquetas que coinciden con todos los IDs de etiquetas especificados. Es posible que los mensajes de un hilo tengan etiquetas que otros mensajes del mismo hilo no tengan. Para obtener más información, consulta Administra etiquetas en 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 solo contiene un id y un threadId. Se pueden recuperar detalles adicionales del mensaje con el método messages.get.
nextPageToken

string

Es un token para recuperar la siguiente página de resultados en la lista.
resultSizeEstimate

integer (uint32 format)

Es la cantidad total estimada de resultados.

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