Method: users.drafts.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Elenca le bozze nella cassetta di posta dell'utente.
Richiesta HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts
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 bozze 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 di bozza 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" .
|
includeSpamTrash |
boolean
Includi le bozze 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 |
{
"drafts": [
{
object (Draft )
}
],
"nextPageToken": string,
"resultSizeEstimate": integer
} |
Campi |
drafts[] |
object (Draft )
Elenco di bozze. Tieni presente che la proprietà Message in ogni risorsa Draft contiene solo un id e un threadId . Il metodo messages.get può recuperare ulteriori dettagli del messaggio.
|
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.compose
https://www.googleapis.com/auth/gmail.readonly
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: users.drafts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDraftsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the drafts in the user's mailbox.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Query parameters\n\n| Parameters ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500. |\n| `pageToken` | `string` Page token to retrieve a specific page of results in the list. |\n| `q` | `string` Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid:\u003csomemsgid@example.com\u003e is:unread\"`. |\n| `includeSpamTrash` | `boolean` Include drafts from `SPAM` and `TRASH` in the results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"drafts\": [ { object (/workspace/gmail/api/reference/rest/v1/users.drafts#Draft) } ], \"nextPageToken\": string, \"resultSizeEstimate\": integer } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `drafts[]` | `object (`[Draft](/workspace/gmail/api/reference/rest/v1/users.drafts#Draft)`)` List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The [`messages.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method can fetch additional message details. |\n| `nextPageToken` | `string` Token to retrieve the next page of results in the list. |\n| `resultSizeEstimate` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` Estimated total number of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.compose`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]