Este documento explica como gerenciar marcadores em conversas e mensagens usando a API Gmail.
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
o recurso labels.
Para gerenciar rótulos, use o escopo não sensível https://www.googleapis.com/auth/gmail.labels. Para mais
informações sobre escopos, consulte Escolher escopos 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 INBOX. 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 alguns 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 que são:
|
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 conversas e mensagens
Os rótulos só existem em mensagens. Se você recuperar uma lista de marcadores em uma conversa, vai receber uma lista de marcadores que existem em qualquer mensagem na conversa. Um marcador pode não existir em todas as mensagens de uma conversa.
Não é possível aplicar marcadores a mensagens em rascunho.
Adicionar ou remover marcadores de conversas
Quando você adiciona ou remove um marcador em uma conversa, o marcador especificado é adicionado ou removido de todas as mensagens na conversa.
Se mensagens forem adicionadas a uma conversa depois que você adicionar um rótulo, elas não herdarão o rótulo 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.