Dokumen ini menjelaskan cara mengelola label pada rangkaian pesan dan pesan menggunakan Gmail API.
Anda dapat menggunakan label untuk memberi tag, mengatur, dan mengategorikan pesan dan rangkaian pesan di Gmail. Label memiliki hubungan many-to-many dengan pesan dan rangkaian pesan: Anda dapat menerapkan beberapa label ke satu pesan atau rangkaian pesan, dan menerapkan satu label ke beberapa pesan atau rangkaian pesan.
Untuk mengetahui informasi tentang cara
membuat,
mendapatkan,
mencantumkan,
memperbarui, atau
menghapus label, lihat
resource labels.
Untuk mengelola label, Anda harus menggunakan cakupan tidak sensitif
https://www.googleapis.com/auth/gmail.labels. Untuk mengetahui informasi selengkapnya tentang cakupan, lihat Memilih cakupan Gmail API.
Jenis label
Label tersedia dalam dua jenis: label SYSTEM yang dipesan dan label USER kustom.
Label sistem biasanya sesuai dengan elemen yang telah ditentukan sebelumnya di
antarmuka web Gmail seperti INBOX. Nama label sistem dicadangkan; tidak ada label USER yang dapat dibuat dengan nama yang sama dengan label SYSTEM. Tabel berikut mencantumkan beberapa label sistem Gmail yang paling umum:
| Nama | Dapat diterapkan secara manual | Catatan |
|---|---|---|
INBOX |
ya | |
SPAM |
ya | |
TRASH |
ya | |
UNREAD |
ya | |
STARRED |
ya | |
IMPORTANT |
ya | |
SENT |
tidak | Diterapkan secara otomatis ke pesan yang:
|
DRAFT |
tidak | Diterapkan secara otomatis ke semua pesan yang dibuat dengan Gmail API atau antarmuka Gmail.draft |
CATEGORY_PERSONAL |
ya | Sesuai dengan pesan yang ditampilkan di tab Personal di antarmuka Gmail. |
CATEGORY_SOCIAL |
ya | Sesuai dengan pesan yang ditampilkan di tab Sosial pada antarmuka Gmail. |
CATEGORY_PROMOTIONS |
ya | Sesuai dengan pesan yang ditampilkan di tab Promosi antarmuka Gmail. |
CATEGORY_UPDATES |
ya | Sesuai dengan pesan yang ditampilkan di tab Pembaruan pada antarmuka Gmail. |
CATEGORY_FORUMS |
ya | Sesuai dengan pesan yang ditampilkan di tab Forum pada antarmuka Gmail. |
Mengelola label pada rangkaian pesan dan pesan
Label hanya ada pada pesan. Jika Anda mengambil daftar label pada rangkaian pesan, Anda akan mendapatkan daftar label yang ada pada pesan apa pun dalam rangkaian pesan tersebut. Label mungkin tidak ada di setiap pesan dalam rangkaian pesan.
Anda tidak dapat menerapkan label ke pesan draf.
Menambahkan atau menghapus label pada rangkaian pesan
Saat Anda menambahkan atau menghapus label pada rangkaian pesan, Anda menambahkan atau menghapus label tertentu pada semua pesan yang ada dalam rangkaian pesan tersebut.
Jika pesan ditambahkan ke rangkaian pesan setelah Anda menambahkan label, pesan baru tidak mewarisi label yang ada yang terkait dengan rangkaian pesan. Untuk menambahkan label ke pesan tersebut, tambahkan label ke rangkaian pesan lagi.
Untuk menambahkan atau menghapus label yang terkait dengan rangkaian pesan, gunakan
threads.modify.
Menambahkan atau menghapus label pada pesan
Saat Anda menambahkan label ke pesan, label tersebut akan ditambahkan ke pesan tersebut dan dikaitkan dengan rangkaian pesan yang berisi pesan tersebut. Label tidak ditambahkan ke pesan lain dalam rangkaian pesan.
Jika Anda menghapus label dari pesan dan pesan tersebut adalah satu-satunya pesan dalam rangkaian email dengan label tersebut, label juga akan dihapus dari rangkaian email.
Untuk menambahkan atau menghapus label yang diterapkan ke pesan, gunakan
messages.modify.