Você pode usar marcadores para marcar, organizar e categorizar mensagens e conversas no Gmail. Um marcador tem uma relação de muitos para muitos com mensagens e conversas: é possível aplicar vários marcadores a uma única mensagem ou conversa e aplicar um único marcador a várias mensagens ou conversas.
Para informações sobre como criar, get, listar, atualizar ou excluir rótulos, consulte a Referência de rótulos.
Para gerenciar rótulos, use o escopo https://www.googleapis.com/auth/gmail.labels. Para mais informações sobre escopos, consulte Informações de autorização e autenticação específicas da API Gmail.
Tipos de rótulo
Há duas variedades de rótulos: SYSTEM reservados e USER personalizados.
Os rótulos do sistema geralmente correspondem a elementos predefinidos na interface da Web do Gmail, como a caixa de entrada. Os nomes de rótulos dos sistemas são reservados. Nenhum rótulo USER pode
ser criado com o mesmo nome de um rótulo SYSTEM. A tabela a seguir lista vários dos marcadores mais comuns do sistema do Gmail:
| Nome | Pode ser aplicado manualmente | Observações |
|---|---|---|
INBOX |
sim | |
SPAM |
sim | |
TRASH |
sim | |
UNREAD |
sim | |
STARRED |
sim | |
IMPORTANT |
sim | |
SENT |
não | Aplicado automaticamente a mensagens enviadas com
drafts.send ou
messages.send, inseridas
com messages.insert
e e-mail do usuário no cabeçalho From, ou enviadas pelo usuário
pela interface da Web. |
DRAFT |
não | Aplicado automaticamente a todas as mensagens draft criadas com a API ou a interface do Gmail. |
CATEGORY_PERSONAL |
sim | Corresponde às mensagens exibidas na guia "Pessoal" da interface do Gmail. |
CATEGORY_SOCIAL |
sim | Corresponde às mensagens exibidas na guia "Social" da interface do Gmail. |
CATEGORY_PROMOTIONS |
sim | Corresponde às mensagens exibidas na guia "Promoções" da interface do Gmail. |
CATEGORY_UPDATES |
sim | Corresponde às mensagens exibidas na guia "Atualizações" da interface do Gmail. |
CATEGORY_FORUMS |
sim | Corresponde às mensagens exibidas na guia "Fóruns" da interface do Gmail. |
Gerenciar marcadores em mensagens e conversas
Os marcadores só existem nas mensagens. Por exemplo, se você listar marcadores em uma conversa, receberá uma lista dos marcadores que existem em qualquer uma das mensagens da conversa. Um marcador pode não existir em todas as mensagens de uma conversa. É possível aplicar vários marcadores às mensagens, mas não aplicá-los a mensagens de rascunho.
Adicionar ou remover marcadores em conversas
Ao adicionar ou remover um marcador de uma conversa, você adiciona ou remove o marcador especificado em todas as mensagens na conversa.
Se as mensagens forem adicionadas a uma conversa depois que você adicionar um marcador, as novas mensagens não herdarão o marcador existente associado à conversa. Para adicionar o marcador a essas mensagens, adicione-o à conversa novamente.
Para adicionar ou remover os rótulos associados a uma linha de execução, use
threads.modify.
Adicionar ou remover marcadores de mensagens
Quando você adiciona um marcador a uma mensagem, ele é adicionado a ela e é associado à conversa à qual a mensagem pertence. O marcador não é adicionado a outras mensagens na conversa.
Se você remover um marcador de uma mensagem e ele for a única na conversa com esse marcador, ele também será removido da conversa.
Para adicionar ou remover os marcadores aplicados a uma mensagem, use
messages.modify.