Method: users.messages.list

Elenca i messaggi nella casella di posta dell'utente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
userId

string

L'indirizzo email dell'utente. Il valore speciale me può essere utilizzato per indicare l'utente autenticato.

Parametri di query

Parametri
maxResults

integer (uint32 format)

Il numero massimo di messaggi da restituire. Il valore predefinito di questo campo è 100. Il valore massimo consentito per questo campo è 500.
pageToken

string

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

string

Restituisce solo i messaggi corrispondenti 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". Il parametro non può essere utilizzato quando si accede all'API utilizzando l'ambito gmail.metadata.
labelIds[]

string

Restituisce solo i messaggi con le etichette che corrispondono a tutti gli ID etichetta specificati. I messaggi di un thread potrebbero avere etichette che non sono presenti in altri messaggi dello stesso thread. Per scoprire di più, vedi Gestire le etichette su messaggi e thread.
includeSpamTrash

boolean

Includi i messaggi di SPAM e TRASH nei risultati.

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

object (Message)

Elenco di messaggi. Tieni presente che ogni risorsa messaggio contiene solo un id e un threadId. È possibile recuperare ulteriori dettagli sul messaggio utilizzando il metodo messages.get.
nextPageToken

string

Token per recuperare la pagina di risultati successiva 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 all'autorizzazione.