ป้ายกำกับที่ผู้ใช้สร้างขึ้นในบัญชี Gmail ของผู้ใช้
เมธอด
| เมธอด | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
|---|---|---|
add | Gmail | เพิ่มป้ายกำกับนี้ลงในชุดข้อความที่ระบุและบังคับให้ชุดข้อความรีเฟรช (Gmail) |
add | Gmail | เพิ่มป้ายกำกับนี้ลงในชุดข้อความที่ระบุและบังคับให้ชุดข้อความรีเฟรช |
delete | void | ลบป้ายกำกับนี้ |
get | String | รับรหัสของป้ายกำกับนี้ |
get | String | รับชื่อของป้ายกำกับนี้ |
get | Gmail | รับชุดข้อความที่มีป้ายกำกับนี้ |
get | Gmail | รับชุดข้อความช่วงหนึ่งที่มีป้ายกำกับนี้ |
get | Integer | รับจำนวนชุดข้อความที่ยังไม่อ่านซึ่งติดป้ายกำกับนี้ |
remove | Gmail | นำป้ายกำกับนี้ออกจากชุดข้อความที่ระบุและบังคับให้ชุดข้อความรีเฟรช |
remove | Gmail | นำป้ายกำกับนี้ออกจากชุดข้อความที่ระบุและบังคับให้ชุดข้อความรีเฟรช |
เอกสารโดยละเอียด
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 | Gmail | ชุดข้อความที่จะติดป้ายกำกับ |
รีเทิร์น
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);
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
threads | Gmail | อาร์เรย์ของชุดข้อความที่จะติดป้ายกำกับ |
รีเทิร์น
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()); }
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
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 | Gmail | ชุดข้อความที่จะนำป้ายกำกับออก |
รีเทิร์น
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);
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
threads | Gmail | อาร์เรย์ของชุดข้อความที่จะนำป้ายกำกับออก |
รีเทิร์น
GmailLabel \- ป้ายกำกับนี้สำหรับการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์ที่มี ขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขตหรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://mail.google.com/