Class GmailLabel

GmailLabel

Label yang dibuat pengguna di akun Gmail pengguna.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addToThread(thread)GmailLabelMenambahkan label ini ke rangkaian pesan tertentu dan memaksa rangkaian pesan untuk dimuat ulang (GmailThread.refresh()).
addToThreads(threads)GmailLabelMenambahkan label ini ke rangkaian pesan tertentu dan memaksa rangkaian pesan untuk dimuat ulang.
deleteLabel()voidMenghapus label ini.
getName()StringMendapatkan nama label ini.
getThreads()GmailThread[]Mendapatkan thread yang ditandai dengan label ini.
getThreads(start, max)GmailThread[]Mendapatkan rentang thread yang ditandai dengan label ini.
getUnreadCount()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca dan diberi tag dengan label ini.
removeFromThread(thread)GmailLabelMenghapus label ini dari rangkaian pesan yang diberikan dan memaksa rangkaian pesan untuk dimuat ulang.
removeFromThreads(threads)GmailLabelMenghapus label ini dari thread yang diberikan dan memaksa thread untuk dimuat ulang.

Dokumentasi mendetail

addToThread(thread)

Menambahkan label ini ke rangkaian pesan tertentu dan memaksa rangkaian pesan untuk dimuat ulang (GmailThread.refresh()).

// label the first thread in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

Parameter

NamaJenisDeskripsi
threadGmailThreadRangkaian pesan yang akan diberi label.

Pulang pergi

GmailLabel — Label ini, untuk pengaitan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

Lihat juga


addToThreads(threads)

Menambahkan label ini ke rangkaian pesan tertentu dan memaksa rangkaian pesan untuk dimuat ulang. Anda dapat menambahkan label untuk maksimal 100 thread per batch.

// label the first three threads in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

Parameter

NamaJenisDeskripsi
threadsGmailThread[]Array rangkaian pesan yang akan diberi label.

Pulang pergi

GmailLabel — Label ini, untuk pengaitan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

Lihat juga


deleteLabel()

Menghapus label ini.

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

Menampilkan

Error — jika label tidak dapat dihapus

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

Lihat juga


getName()

Mendapatkan nama label ini.

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

Pulang pergi

String — Nama label.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

getThreads()

Mendapatkan thread yang ditandai dengan label ini.

Panggilan ini gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan berpotensi sangat besar, gunakan getThreads(start, max) dan tentukan rentang thread yang akan diambil dalam setiap panggilan.

// Log the subject lines of the threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Pulang pergi

GmailThread[] — Array thread yang ditandai dengan label ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

getThreads(start, max)

Mendapatkan rentang thread yang ditandai dengan label ini.

// log the subject lines of up to the first 30 threads with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parameter

NamaJenisDeskripsi
startIntegerIndeks thread awal.
maxIntegerJumlah maksimum thread yang akan ditampilkan.

Pulang pergi

GmailThread[] — Array thread yang ditandai dengan label ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

getUnreadCount()

Mendapatkan jumlah rangkaian pesan yang belum dibaca dan diberi tag dengan label ini.

// log the number of unread threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

Pulang pergi

Integer — Jumlah rangkaian pesan berlabel yang belum dibaca.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

removeFromThread(thread)

Menghapus label ini dari rangkaian pesan yang diberikan dan memaksa rangkaian pesan untuk dimuat ulang.

// remove the label MyLabel from the first thread in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

Parameter

NamaJenisDeskripsi
threadGmailThreadRangkaian pesan tidak diberi label.

Pulang pergi

GmailLabel — Label ini, untuk pengaitan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

Lihat juga


removeFromThreads(threads)

Menghapus label ini dari thread yang diberikan dan memaksa thread untuk dimuat ulang. Anda dapat menghapus label untuk maksimal 100 rangkaian pesan per batch.

// remove the label MyLabel from the first three threads in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

Parameter

NamaJenisDeskripsi
threadsGmailThread[]Array rangkaian pesan yang akan diberi label.

Pulang pergi

GmailLabel — Label ini, untuk pengaitan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

  • https://mail.google.com/

Lihat juga