Class GmailLabel

Label Gmail

Label yang dibuat pengguna di akun Gmail pengguna.

Metode

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

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

Parameter

NameJenisDeskripsi
threadGmailThreadThread yang akan diberi label.

Return

GmailLabel — Label ini, untuk perantaian.

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 thread yang diberikan dan memaksa thread untuk dimuat ulang. Anda dapat menambahkan label untuk hingga 100 thread per batch.

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

Parameter

NameJenisDeskripsi
threadsGmailThread[]Array thread yang akan diberi label.

Return

GmailLabel — Label ini, untuk perantaian.

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.

var 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.

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

Return

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 rangkaian pesan yang ditandai dengan label ini.

Panggilan ini akan 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 di setiap panggilan.

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

Return

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 rangkaian pesan yang ditandai dengan label ini.

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

Parameter

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

Return

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 yang diberi tag ini.

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

Return

Integer — Jumlah rangkaian pesan yang belum diberi 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/

removeFromThread(thread)

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

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

Parameter

NameJenisDeskripsi
threadGmailThreadRangkaian pesan tidak diberi label.

Return

GmailLabel — Label ini, untuk perantaian.

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 thread per batch.

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

Parameter

NameJenisDeskripsi
threadsGmailThread[]Array thread yang tidak diberi label.

Return

GmailLabel — Label ini, untuk perantaian.

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