Method: users.messages.list

Lista as mensagens na caixa de e-mails do usuário.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
userId

string

O endereço de e-mail do usuário. O valor especial me pode ser usado para indicar o usuário autenticado.

Parâmetros de consulta

Parâmetros
maxResults

integer (uint32 format)

Número máximo de mensagens a serem retornadas. O padrão desse campo é 100. O valor máximo permitido para esse campo é 500.
pageToken

string

Token de página para recuperar uma página específica de resultados na lista.
q

string

Retorna apenas mensagens que correspondem à consulta especificada. Suporta o mesmo formato de consulta da caixa de pesquisa do Gmail. Por exemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". O parâmetro não pode ser usado ao acessar a API usando o escopo gmail.metadata.
labelIds[]

string

Retorna apenas mensagens com rótulos que correspondem a todos os IDs de rótulo especificados. As mensagens em uma conversa podem ter marcadores que outras mensagens na mesma conversa não têm. Para saber mais, consulte Gerenciar rótulos em mensagens e conversas.
includeSpamTrash

boolean

Inclua mensagens de SPAM e TRASH nos resultados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Campos
messages[]

object (Message)

Lista de mensagens. Cada recurso de mensagem contém apenas um id e um threadId. Outros detalhes da mensagem podem ser buscados usando o método messages.get.
nextPageToken

string

Token para recuperar a próxima página de resultados na lista.
resultSizeEstimate

integer (uint32 format)

Número total estimado de resultados.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte o guia de autorização.