Method: users.labels.list

Lista todos os marcadores na caixa de correio do usuário.

Solicitação HTTP

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

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.

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 
{
  "labels": [
    {
      object (Label)
    }
  ]
}
Campos
labels[]

object (Label)

Lista de rótulos. Cada recurso de rótulo contém apenas id, name, messageListVisibility, labelListVisibility e type. O método labels.get pode buscar outros detalhes do rótulo.

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.labels
  • https://www.googleapis.com/auth/gmail.metadata

Para mais informações, consulte o guia de autorização.