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 saber como criar, receber, 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ótulos
Há dois tipos de rótulos: reservados SYSTEM
e personalizados USER
.
Os marcadores do sistema geralmente correspondem a elementos predefinidos na interface da Web do Gmail, como a caixa de entrada. Os nomes de rótulos do sistema são reservados. Não é possível criar um rótulo USER
com o mesmo nome de um rótulo SYSTEM
. A tabela a seguir lista
vários dos marcadores do sistema do Gmail mais comuns:
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 o e-mail do usuário no cabeçalho From ou enviadas pelo usuário na
interface da Web. |
DRAFT |
não | Aplicado automaticamente a todas as mensagens
draft criadas com a
API Gmail 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 que aparecem 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 que aparecem 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 rótulos só existem em mensagens. Por exemplo, se você listar os marcadores em uma conversa, vai receber uma lista dos marcadores que existem em qualquer uma das mensagens na conversa. Um rótulo pode não existir em todas as mensagens de uma conversa. É possível aplicar vários marcadores a mensagens, mas não a rascunhos.
Adicionar ou remover marcadores de conversas
Quando você adiciona ou remove um marcador de uma conversa, o marcador especificado é adicionado ou removido de todas as mensagens da conversa.
Se mensagens forem adicionadas a uma conversa depois que você adicionar um marcador, elas não vão herdar o marcador associado à conversa. Para adicionar o rótulo a essas mensagens, adicione-o à conversa novamente.
Para adicionar ou remover os rótulos associados a uma conversa, use
threads.modify
.
Adicionar ou remover marcadores de mensagens
Quando você adiciona um marcador a uma mensagem, ele é adicionado a ela e fica associado à conversa a que a mensagem pertence. O marcador não é adicionado a outras mensagens na conversa.
Se você remover um marcador de uma mensagem e ela for a única na conversa com esse marcador, ele também será removido da conversa.
Para adicionar ou remover os rótulos aplicados a uma mensagem, use
messages.modify
.