Method: users.drafts.list

Muestra una lista de los borradores en el buzón del usuario.

Solicitud HTTP

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

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. El valor especial me se puede usar para indicar el usuario autenticado.

Parámetros de consulta

Parámetros
maxResults

integer (uint32 format)

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

string

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

string

Solo muestra los mensajes de borrador que coincidan con la consulta especificada. Admite el mismo formato de consulta que el cuadro de búsqueda de Gmail. Por ejemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
includeSpamTrash

boolean

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

object (Draft)

Lista de borradores. Ten en cuenta que la propiedad Message en cada recurso Draft solo contiene un id y un threadId. El método messages.get puede recuperar detalles adicionales del mensaje.
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.compose
  • https://www.googleapis.com/auth/gmail.readonly

Para obtener más información, consulta la Guía de autorización.