Method: users.threads.list

Enumera los subprocesos en el buzón del usuario.

Solicitud HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

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 subprocesos 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 subprocesos que coinciden con la búsqueda 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 se devuelven los subprocesos con etiquetas que coinciden con todos los IDs de etiquetas especificados.
includeSpamTrash

boolean

Incluye los subprocesos 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 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Campos
threads[]

object (Thread)

Es la lista de subprocesos. Ten en cuenta que cada recurso de subproceso no contiene una lista de messages. La lista de messages para un subproceso determinado se puede recuperar con el método threads.get.
nextPageToken

string

Es el token de página 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 OAuth 2.0 Overview.