Class GmailLabel

ป้ายกำกับGmail

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

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addToThread(thread)GmailLabelเพิ่มป้ายกำกับนี้ลงในชุดข้อความที่ระบุและบังคับให้ชุดข้อความรีเฟรช (GmailThread.refresh())
addToThreads(threads)GmailLabelเพิ่มป้ายกำกับนี้ลงในชุดข้อความที่ระบุและบังคับให้ชุดข้อความรีเฟรช
deleteLabel()voidลบป้ายกำกับนี้
getId()Stringรับรหัสของป้ายกำกับนี้
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 const label = GmailApp.getUserLabelByName('MyLabel'); const 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 const label = GmailApp.getUserLabelByName('MyLabel'); const threads = GmailApp.getInboxThreads(0, 3); label.addToThreads(threads);

พารามิเตอร์

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

รีเทิร์น

GmailLabel — ป้ายกำกับนี้สำหรับการเชื่อมโยง

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


deleteLabel()

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

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

การขว้าง

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getId()

รับรหัสของป้ายกำกับนี้

const label = GmailApp.getUserLabelByName('MyLabel'); console.log(label.getId());

รีเทิร์น

String — รหัสของป้ายกำกับ

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

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

  • https://mail.google.com/

getName()

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

const 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 const label = GmailApp.getUserLabelByName('MyLabel'); const threads = label.getThreads(); for (let 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 const label = GmailApp.getUserLabelByName('MyLabel'); const threads = label.getThreads(0, 30); for (let 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 const 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 const label = GmailApp.getUserLabelByName('MyLabel'); const 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 const label = GmailApp.getUserLabelByName('MyLabel'); const threads = GmailApp.getInboxThreads(0, 3); label.removeFromThreads(threads);

พารามิเตอร์

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

รีเทิร์น

GmailLabel — ป้ายกำกับนี้สำหรับการเชื่อมโยง

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

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

  • https://mail.google.com/

ดูเพิ่มเติม