Class GmailLabel

GmailLabel

ป้ายกำกับที่ผู้ใช้สร้างในบัญชี Gmail ของผู้ใช้

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addToThread(thread)GmailLabelเพิ่มป้ายกำกับนี้ในชุดข้อความที่กำหนดและบังคับให้รีเฟรชชุดข้อความ (GmailThread.refresh())
addToThreads(threads)GmailLabelเพิ่มป้ายกำกับนี้ในชุดข้อความที่ระบุและบังคับให้รีเฟรชชุดข้อความ
deleteLabel()voidลบป้ายกำกับนี้
getName()Stringดึงชื่อของป้ายกำกับนี้
getThreads()GmailThread[]รับชุดข้อความที่มีป้ายกำกับนี้
getThreads(start, max)GmailThread[]รับช่วงของชุดข้อความที่มีเครื่องหมายกำกับนี้
getUnreadCount()Integerรับจำนวนชุดข้อความที่ยังไม่อ่านที่ติดแท็กป้ายกำกับนี้
removeFromThread(thread)GmailLabelนำป้ายกำกับนี้ออกจากชุดข้อความที่ระบุและบังคับให้รีเฟรชชุดข้อความ
removeFromThreads(threads)GmailLabelนำป้ายกำกับนี้ออกจากชุดข้อความที่ระบุและบังคับให้รีเฟรชชุดข้อความ

เอกสารโดยละเอียด

addToThread(thread)

เพิ่มป้ายกำกับนี้ในชุดข้อความที่กำหนดและบังคับให้รีเฟรชชุดข้อความ (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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะติดป้ายกำกับ

รีเทิร์น

GmailLabel — ป้ายกำกับนี้สำหรับการทำสาย

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม

addToThreads(threads)

เพิ่มป้ายกำกับนี้ในชุดข้อความที่ระบุและบังคับให้รีเฟรชชุดข้อความ คุณสามารถเพิ่มป้ายกำกับสำหรับ สูงสุด 100 ชุดข้อความต่อกลุ่ม 

// 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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะติดป้ายกำกับ

รีเทิร์น

GmailLabel — ป้ายกำกับนี้สำหรับการทำสาย

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม

deleteLabel()

ลบป้ายกำกับนี้ 

var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

การขว้าง

Error — หากลบป้ายกำกับไม่ได้

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม

getName()

ดึงชื่อของป้ายกำกับนี้ 

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

รีเทิร์น

String — ชื่อป้ายกำกับ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

getThreads()

รับชุดข้อความที่มีป้ายกำกับนี้

การเรียกนี้ล้มเหลวเมื่อเทรดทั้งหมดมีขนาดใหญ่เกินกว่าที่ระบบจะจัดการได้ สถานที่ ไม่ทราบขนาดชุดข้อความ และอาจมีขนาดใหญ่มาก โปรดใช้ getThreads(start, max) และระบุช่วงของชุดข้อความเพื่อดึงข้อมูลในการเรียกใช้แต่ละครั้ง 

// 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());
}

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความที่ติดป้ายกำกับนี้

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

getThreads(start, max)

รับช่วงของชุดข้อความที่มีเครื่องหมายกำกับนี้ 

// 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());
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของชุดข้อความเริ่มต้น
maxIntegerจำนวนเทรดสูงสุดที่จะแสดง

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความที่ติดป้ายกำกับนี้

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

getUnreadCount()

รับจำนวนชุดข้อความที่ยังไม่อ่านที่ติดแท็กป้ายกำกับนี้ 

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

รีเทิร์น

Integer — จำนวนชุดข้อความที่ยังไม่อ่าน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

removeFromThread(thread)

นำป้ายกำกับนี้ออกจากชุดข้อความที่ระบุและบังคับให้รีเฟรชชุดข้อความ 

// 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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความจะไม่มีป้ายกำกับ

รีเทิร์น

GmailLabel — ป้ายกำกับนี้สำหรับการทำสาย

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม

removeFromThreads(threads)

นำป้ายกำกับนี้ออกจากชุดข้อความที่ระบุและบังคับให้รีเฟรชชุดข้อความ คุณสามารถนำออก สำหรับชุดข้อความได้สูงสุด 100 หัวข้อต่อกลุ่ม 

// 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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะไม่มีป้ายกำกับ

รีเทิร์น

GmailLabel — ป้ายกำกับนี้สำหรับการทำสาย

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม