Class GmailLabel

GmailLabel

ป้ายกำกับที่ผู้ใช้สร้างขึ้นในบัญชี 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);

พารามิเตอร์

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

รีเทิร์น

GmailLabel — ป้ายกำกับนี้ใช้สำหรับเชน

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

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

• https://mail.google.com/

ดูเพิ่มเติม

• removeFromThread(thread)

---

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

พารามิเตอร์

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

รีเทิร์น

GmailLabel — ป้ายกำกับนี้ใช้สำหรับเชน

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

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

• https://mail.google.com/

ดูเพิ่มเติม

• removeFromThreads(threads)

---

deleteLabel()

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

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

การโยน

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

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

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

• https://mail.google.com/

ดูเพิ่มเติม

• getName()

---

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

พารามิเตอร์

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

รีเทิร์น

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

พารามิเตอร์

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

รีเทิร์น

GmailLabel — ป้ายกำกับนี้ใช้สำหรับเชน

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

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

• https://mail.google.com/

ดูเพิ่มเติม

• addToThread(thread)

---

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

พารามิเตอร์

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

รีเทิร์น

GmailLabel — ป้ายกำกับนี้ใช้สำหรับเชน

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

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

• https://mail.google.com/

ดูเพิ่มเติม

• addToThreads(threads)