Method: users.threads.list

Elenca i thread nella casella di posta dell'utente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
userId

string

L'indirizzo email dell'utente. È possibile utilizzare il valore speciale me per indicare l'utente autenticato.

Parametri di ricerca

Parametri
maxResults

integer (uint32 format)

Numero massimo di thread da restituire. L'impostazione predefinita di questo campo è 100. Il valore massimo consentito per questo campo è 500.

pageToken

string

Token di pagina per recuperare una pagina specifica di risultati nell'elenco.

q

string

Restituisci solo i thread che corrispondono alla query specificata. Supporta lo stesso formato di query della casella di ricerca di Gmail. Ad esempio, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Impossibile utilizzare il parametro quando si accede all'API tramite l'ambito gmail.metadata.

labelIds[]

string

Restituisci solo thread con etichette che corrispondono a tutti gli ID etichetta specificati.

includeSpamTrash

boolean

Includi nei risultati i thread di SPAM e TRASH.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Campi
threads[]

object (Thread)

Elenco di thread. Tieni presente che ogni risorsa thread non contiene un elenco di messages. L'elenco di messages per un determinato thread può essere recuperato utilizzando il metodo threads.get.

nextPageToken

string

Token di pagina per recuperare la pagina successiva dei risultati nell'elenco.

resultSizeEstimate

integer (uint32 format)

Numero totale stimato di risultati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per ulteriori informazioni, consulta la Guida alle autorizzazioni.