ป้ายกำกับที่ผู้ใช้สร้างในบัญชี 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);
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
thread | GmailThread | ชุดข้อความที่จะติดป้ายกำกับ |
รีเทิร์น
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);
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
threads | GmailThread[] | อาร์เรย์ของชุดข้อความที่จะติดป้ายกำกับ |
รีเทิร์น
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()); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
start | Integer | ดัชนีของชุดข้อความเริ่มต้น |
max | Integer | จำนวนชุดข้อความสูงสุดที่จะแสดง |
รีเทิร์น
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);
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
thread | GmailThread | ชุดข้อความจะไม่มีป้ายกำกับ |
รีเทิร์น
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);
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
threads | GmailThread[] | อาร์เรย์ของชุดข้อความที่จะไม่มีป้ายกำกับ |
รีเทิร์น
GmailLabel
— ป้ายกำกับนี้สำหรับเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://mail.google.com/