Class GmailThread

GmailThread

ชุดข้อความในบัญชี Gmail ของผู้ใช้

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addLabel(label)GmailThreadเพิ่มป้ายกำกับนี้ลงในชุดข้อความ
createDraftReply(body)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ
createDraftReply(body, options)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ พร้อมด้วยอาร์กิวเมนต์ที่ไม่บังคับ
createDraftReplyAll(body)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมดของข้อความนี้
createDraftReplyAll(body, options)GmailDraftสร้างข้อความร่างที่ตอบกลับไปยังผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมด รวมทั้งอาร์กิวเมนต์หรือไม่ก็ได้
getFirstMessageSubject()Stringรับหัวเรื่องของข้อความแรกในชุดข้อความ
getId()Stringรับรหัสของชุดข้อความนี้
getLabels()GmailLabel[]แสดงผลป้ายกำกับที่ผู้ใช้สร้างในชุดข้อความนี้
getLastMessageDate()Dateรับวันที่ของข้อความล่าสุดของชุดข้อความนี้
getMessageCount()Integerแสดงผลจำนวนข้อความในชุดข้อความ
getMessages()GmailMessage[]รับข้อความในชุดข้อความนี้
getPermalink()Stringรับลิงก์ถาวรสำหรับชุดข้อความนี้
hasStarredMessages()Booleanแสดงผลว่าชุดข้อความมีข้อความที่ติดดาวหรือไม่
isImportant()Booleanแสดงผลว่ามีการทำเครื่องหมายชุดข้อความว่าสำคัญหรือไม่
isInChats()Booleanแสดงผลว่าชุดข้อความมีป้ายกำกับเป็นแชทหรือไม่
isInInbox()Booleanแสดงผลว่าชุดข้อความอยู่ในกล่องจดหมายหรือไม่
isInPriorityInbox()Booleanแสดงผลเป็น "จริง" หากชุดข้อความนี้อยู่ในกล่องจดหมายสำคัญ หรือจะแสดงผลเป็น "เท็จ" หากไม่เป็นเช่นนั้น
isInSpam()Booleanแสดงผลว่าชุดข้อความมีการทำเครื่องหมายว่าเป็นสแปมหรือไม่
isInTrash()Booleanแสดงผลว่าชุดข้อความอยู่ในถังขยะหรือไม่
isUnread()Booleanแสดงผลว่าชุดข้อความมีข้อความที่ยังไม่ได้อ่านหรือไม่
markImportant()GmailThreadทำเครื่องหมายชุดข้อความนี้ว่าสำคัญ
markRead()GmailThreadทำเครื่องหมายชุดข้อความนี้ว่าอ่านแล้ว
markUnimportant()GmailThreadทำเครื่องหมายชุดข้อความนี้ว่าไม่สำคัญ
markUnread()GmailThreadทำเครื่องหมายชุดข้อความนี้ว่ายังไม่อ่าน
moveToArchive()GmailThreadย้ายชุดข้อความนี้ไปยังที่เก็บถาวร
moveToInbox()GmailThreadย้ายชุดข้อความนี้ไปที่กล่องจดหมาย
moveToSpam()GmailThreadย้ายชุดข้อความนี้ไปยังสแปม
moveToTrash()GmailThreadย้ายชุดข้อความนี้ไปที่ถังขยะ
refresh()GmailThreadโหลดชุดข้อความนี้ซ้ำและสถานะที่เกี่ยวข้องจาก Gmail (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะการอ่าน ฯลฯ มีการเปลี่ยนแปลง)
removeLabel(label)GmailThreadนำป้ายกำกับนี้ออกจากชุดข้อความ
reply(body)GmailThreadตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่ "ตอบกลับ"
reply(body, options)GmailThreadคุณตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้ได้โดยใช้อีเมลตอบกลับพร้อมระบุอาร์กิวเมนต์หรือไม่ก็ได้
replyAll(body)GmailThreadตอบกลับผู้ส่ง (โดยใช้ที่อยู่ โปรดตอบกลับ) และผู้รับทั้งหมดของข้อความล่าสุดในชุดข้อความนี้
replyAll(body, options)GmailThreadตอบกลับผู้ส่ง (โดยใช้ที่อยู่ replyTo) และผู้รับทั้งหมดของข้อความล่าสุดในชุดข้อความนี้ โดยจะใส่อาร์กิวเมนต์หรือไม่ก็ได้

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

addLabel(label)

เพิ่มป้ายกำกับนี้ลงในชุดข้อความ

// Add label MyLabel to the first thread in the inbox
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.addLabel(label);

พารามิเตอร์

ชื่อTypeคำอธิบาย
labelGmailLabelป้ายกำกับที่จะใช้กับชุดข้อความนี้

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


createDraftReply(body)

สร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ ขนาดของอีเมล (รวมถึงส่วนหัว) ถูกจำกัด

// Create a draft reply to the message author with an acknowledgement.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.createDraftReply("Got your message");

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล

รีเทิร์น

GmailDraft — ข้อความร่างที่สร้างขึ้นใหม่

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


createDraftReply(body, options)

สร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ พร้อมด้วยอาร์กิวเมนต์ที่ไม่บังคับ

โดยอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดของอีเมล (รวมถึงส่วนหัว) คือโควต้าที่จำกัด

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูง ดังที่แสดงด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อTypeคำอธิบาย
attachmentsBlobSource[]อาร์เรย์ของไฟล์ที่จะส่งพร้อมกับอีเมล
bccStringรายการที่อยู่อีเมลที่คั่นด้วยจุลภาคในสำเนาลับ
ccStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาคสำหรับส่งสำเนาถึง
fromStringที่อยู่ที่ใช้ส่งอีเมล ซึ่งต้องเป็นค่าใดค่าหนึ่งที่ GmailApp.getAliases() แสดงผล
htmlBodyStringหากตั้งค่าไว้ อุปกรณ์ที่แสดงผล HTML ได้จะใช้อาร์กิวเมนต์ดังกล่าวแทนอาร์กิวเมนต์เนื้อหาที่จำเป็น คุณเพิ่มช่อง inlineImages ในเนื้อหา HTML ได้หากมีรูปภาพในบรรทัดสำหรับอีเมล
inlineImagesObjectออบเจ็กต์ JavaScript ที่มีการแมปจากคีย์รูปภาพ (String) กับข้อมูลรูปภาพ (BlobSource) โดยจะถือว่ามีการใช้พารามิเตอร์ htmlBody และมีการอ้างอิงรูปภาพเหล่านี้ในรูปแบบ <img src="cid:imageKey" />
nameStringชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)
subjectStringบรรทัดเรื่องใหม่สำหรับอีเมล (สูงสุด 250 อักขระ)

รีเทิร์น

GmailDraft — ข้อความร่างที่สร้างขึ้นใหม่

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


createDraftReplyAll(body)

สร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมดของข้อความนี้ ขนาดของอีเมล (รวมถึงส่วนหัว) จะจำกัดโควต้า

// Create a draft reply to all recipients (except those bcc'd) of the last email in this
// thread.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล

รีเทิร์น

GmailDraft — ข้อความร่างที่สร้างขึ้นใหม่

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


createDraftReplyAll(body, options)

สร้างข้อความร่างที่ตอบกลับไปยังผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมด รวมทั้งอาร์กิวเมนต์หรือไม่ก็ได้

โดยอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดของอีเมล (รวมถึงส่วนหัว) คือโควต้าที่จำกัด

// Create a draft reply, using an HTML text body, to all recipients (except those bcc'd) of
// the last email of in this thread.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูง ดังที่แสดงด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อTypeคำอธิบาย
attachmentsBlobSource[]อาร์เรย์ของไฟล์ที่จะส่งพร้อมกับอีเมล
bccStringรายการที่อยู่อีเมลที่คั่นด้วยจุลภาคในสำเนาลับ
ccStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาคสำหรับส่งสำเนาถึง
fromStringที่อยู่ที่ใช้ส่งอีเมล ซึ่งต้องเป็นค่าใดค่าหนึ่งที่ GmailApp.getAliases() แสดงผล
htmlBodyStringหากตั้งค่าไว้ อุปกรณ์ที่แสดงผล HTML ได้จะใช้อาร์กิวเมนต์ดังกล่าวแทนอาร์กิวเมนต์เนื้อหาที่จำเป็น คุณเพิ่มช่อง inlineImages ในเนื้อหา HTML ได้หากมีรูปภาพในบรรทัดสำหรับอีเมล
inlineImagesObjectออบเจ็กต์ JavaScript ที่มีการแมปจากคีย์รูปภาพ (String) กับข้อมูลรูปภาพ (BlobSource) โดยจะถือว่ามีการใช้พารามิเตอร์ htmlBody และมีการอ้างอิงรูปภาพเหล่านี้ในรูปแบบ <img src="cid:imageKey" />
nameStringชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)
subjectStringขึ้นบรรทัดเรื่องใหม่สำหรับอีเมล ขนาดสูงสุดคือ 250 อักขระ

รีเทิร์น

GmailDraft — ข้อความร่างที่สร้างขึ้นใหม่

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getFirstMessageSubject()

รับหัวเรื่องของข้อความแรกในชุดข้อความ

// Log the subject of the first message in the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getFirstMessageSubject());

รีเทิร์น

String — หัวเรื่องของข้อความแรกในชุดข้อความ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getId()

รับรหัสของชุดข้อความนี้ รหัสของชุดข้อความจะแตกต่างกันไปตามข้อความของชุดข้อความนั้น สำหรับรหัสที่สอดคล้องกันสำหรับข้อความใดข้อความหนึ่งในชุดข้อความนั้น ให้เรียกใช้ getMessages()[0].getId() แทน

// Log the subject of the first message in the first thread in the inbox.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var id = firstThread.getId();
// Get same thread by its ID.
var thread = GmailApp.getThreadById(id);
Logger.log(thread.getFirstMessageSubject() == firstThread.getFirstMessageSubject()); // True

รีเทิร์น

String — รหัสของชุดข้อความนี้


getLabels()

แสดงผลป้ายกำกับที่ผู้ใช้สร้างในชุดข้อความนี้

// Log the names of the labels attached to the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var labels = firstThread.getLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log(labels[i].getName());
}

รีเทิร์น

GmailLabel[] — อาร์เรย์ของป้ายกำกับสำหรับชุดข้อความนี้

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

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

  • https://mail.google.com/

getLastMessageDate()

รับวันที่ของข้อความล่าสุดของชุดข้อความนี้

// Log the date of the most recent message on the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getLastMessageDate());

รีเทิร์น

Date — วันที่ของข้อความล่าสุดในชุดข้อความ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getMessageCount()

แสดงผลจำนวนข้อความในชุดข้อความ

// Log the number of messages in the thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getMessageCount());

รีเทิร์น

Integer — จำนวนข้อความในชุดข้อความ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getMessages()

รับข้อความในชุดข้อความนี้

// Log the subjects of the messages in the thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
for (var i = 0; i < messages.length; i++) {
  Logger.log(messages[i].getSubject());
}

รีเทิร์น

GmailMessage[] — อาร์เรย์ของข้อความ Gmail ในชุดข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


รับลิงก์ถาวรสำหรับชุดข้อความนี้

โปรดทราบว่าวิธีนี้ใช้ได้เฉพาะในอินเทอร์เฟซ Gmail แบบคลาสสิกเท่านั้น และจะใช้กับ Inbox ไม่ได้

// Logs the permalink for the first thread in the inbox
var thread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(thread.getPermalink());

รีเทิร์น

String — ลิงก์ถาวรสำหรับชุดข้อความนี้


hasStarredMessages()

แสดงผลว่าชุดข้อความมีข้อความที่ติดดาวหรือไม่

// Log if this thread has starred messages
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('has starred : ' + firstThread.hasStarredMessages());

รีเทิร์น

Boolean — จริง หากชุดข้อความมีข้อความที่ติดดาว

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

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

  • https://mail.google.com/

isImportant()

แสดงผลว่ามีการทำเครื่องหมายชุดข้อความว่าสำคัญหรือไม่

// Log if this thread is marked as important
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Important? : ' + firstThread.isImportant());

รีเทิร์น

Boolean — ระบุว่าชุดข้อความสำคัญหรือไม่

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

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

  • https://mail.google.com/

isInChats()

แสดงผลว่าชุดข้อความมีป้ายกำกับเป็นแชทหรือไม่

// Log if this thread is a chat
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('is in chats? : ' + firstThread.isInChats());

รีเทิร์น

Boolean — จริง หากชุดข้อความมีป้ายกำกับเป็นแชท

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

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

  • https://mail.google.com/

isInInbox()

แสดงผลว่าชุดข้อความอยู่ในกล่องจดหมายหรือไม่

// Log if this thread is in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('is in the inbox? : ' + firstThread.isInInbox());

รีเทิร์น

Boolean — เป็นจริงถ้าชุดข้อความอยู่ในกล่องจดหมาย

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

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

  • https://mail.google.com/

isInPriorityInbox()

แสดงผลเป็น "จริง" หากชุดข้อความนี้อยู่ในกล่องจดหมายสำคัญ หรือจะแสดงผลเป็น "เท็จ" หากไม่เป็นเช่นนั้น

// Log if this thread is in the priority inbox
var firstThread = GmailApp.getPriorityInboxThreads(0,1)[0];
Logger.log("is in priority inbox? " + firstThread.isInPriorityInbox());

รีเทิร์น

Boolean — เป็นจริงหากชุดข้อความอยู่ในกล่องจดหมายสำคัญ

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

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

  • https://mail.google.com/

isInSpam()

แสดงผลว่าชุดข้อความมีการทำเครื่องหมายว่าเป็นสแปมหรือไม่

// Log if this thread is in the spam folder
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Spam? ' + firstThread.isInSpam());

รีเทิร์น

Boolean — ระบุว่าชุดข้อความนี้เป็นสแปมหรือไม่

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

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

  • https://mail.google.com/

isInTrash()

แสดงผลว่าชุดข้อความอยู่ในถังขยะหรือไม่

// Log if this thread is in the trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Trashed? ' + firstThread.isInTrash());

รีเทิร์น

Boolean — เป็นจริงหากชุดข้อความอยู่ในถังขยะ

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

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

  • https://mail.google.com/

isUnread()

แสดงผลว่าชุดข้อความมีข้อความที่ยังไม่ได้อ่านหรือไม่

// Log if this thread is unread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Unread? ' + firstThread.isUnread());

รีเทิร์น

Boolean — เป็นจริงหากมีข้อความที่ยังไม่ได้อ่าน

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

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

  • https://mail.google.com/

markImportant()

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

// Mark first inbox thread as important
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markImportant();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


markRead()

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

// Mark first inbox thread as read
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markRead();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


markUnimportant()

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

// Mark first inbox thread as unimportant
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markUnimportant();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


markUnread()

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

// Mark first inbox thread as unread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markUnread();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


moveToArchive()

ย้ายชุดข้อความนี้ไปยังที่เก็บถาวร

// Archive first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToArchive();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

moveToInbox()

ย้ายชุดข้อความนี้ไปที่กล่องจดหมาย

// Move first non-inbox thread to inbox
var firstThread = GmailApp.search("-in:inbox")[0];
firstThread.moveToInbox();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

moveToSpam()

ย้ายชุดข้อความนี้ไปยังสแปม

// Move first inbox thread to spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToSpam();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

moveToTrash()

ย้ายชุดข้อความนี้ไปที่ถังขยะ

// Move first inbox thread to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToTrash();

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

refresh()

โหลดชุดข้อความนี้ซ้ำและสถานะที่เกี่ยวข้องจาก Gmail (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะการอ่าน ฯลฯ มีการเปลี่ยนแปลง)

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
firstThread.refresh(); // Make sure it's up-to-date
// ...Do more stuff with firstThread ...

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

removeLabel(label)

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

var myLabel = GmailApp.getUserLabelByName('<your label>');
var threads = myLabel.getThreads();
for (var x in threads) {
  var thread = threads[x];
  thread.removeLabel(myLabel);
}

พารามิเตอร์

ชื่อTypeคำอธิบาย
labelGmailLabelป้ายกำกับที่จะนำออกจากชุดข้อความนี้

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


reply(body)

ตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้โดยใช้ที่อยู่ "ตอบกลับ"

โปรดทราบว่าขนาดโดยรวมของอีเมล (รวมส่วนหัวทั้งหมด) ต้องไม่เกิน 20 KB

// Respond to author of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.reply("Got your message");

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


reply(body, options)

คุณตอบกลับผู้ส่งข้อความล่าสุดในชุดข้อความนี้ได้โดยใช้อีเมลตอบกลับพร้อมระบุอาร์กิวเมนต์หรือไม่ก็ได้ อีเมลสามารถมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML โปรดทราบว่าขนาดโดยรวมของอีเมล (รวมถึงส่วนหัวทั้งหมด แต่ไม่รวมไฟล์แนบ) ต้องไม่เกิน 20 KB

// Respond with HTML body text.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.reply("incapable of HTML", {
  htmlBody: "some HTML body text",
  noReply: true
});

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูง ดังที่แสดงด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อTypeคำอธิบาย
ccStringรายชื่ออีเมลที่คั่นด้วยจุลภาคไปยังสำเนา
bccStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาคไปยังสำเนาลับ
htmlBodyStringหากตั้งค่าไว้ อุปกรณ์ที่แสดงผล HTML ได้จะใช้อาร์กิวเมนต์ดังกล่าวแทนอาร์กิวเมนต์เนื้อหาที่จำเป็น คุณเพิ่มช่อง inlineImages ในเนื้อหา HTML ได้หากมีรูปภาพในบรรทัดสำหรับอีเมล
nameStringชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
fromStringที่อยู่ที่ใช้ส่งอีเมล ซึ่งต้องเป็นค่าใดค่าหนึ่งที่ GmailApp.getAliases() แสดงผล
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)
noReplyBooleantrue หากควรส่งอีเมลจากอีเมลทั่วไปที่ไม่มีการตอบกลับเพื่อขัดขวางไม่ให้ผู้รับตอบอีเมล ตัวเลือกนี้จะทำได้เฉพาะบัญชี Google Workspace เท่านั้น ไม่ใช่สำหรับผู้ใช้ Gmail
attachmentsBlobSource[]อาร์เรย์ของไฟล์ที่จะส่งพร้อมกับอีเมล
inlineImagesObjectออบเจ็กต์ JavaScript ที่มีการแมปจากคีย์รูปภาพ (String) กับข้อมูลรูปภาพ (BlobSource) โดยจะถือว่ามีการใช้พารามิเตอร์ htmlBody และมีการอ้างอิงรูปภาพเหล่านี้ในรูปแบบ <img src="cid:imageKey" />

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


replyAll(body)

ตอบกลับผู้ส่ง (โดยใช้ที่อยู่ โปรดตอบกลับ) และผู้รับทั้งหมดของข้อความล่าสุดในชุดข้อความนี้

โปรดทราบว่าขนาดโดยรวมของอีเมล (รวมส่วนหัวทั้งหมด) ต้องไม่เกิน 20 KB

// Respond to all with acknowledgment to the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.replyAll("Got your message");

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


replyAll(body, options)

ตอบกลับผู้ส่ง (โดยใช้ที่อยู่ replyTo) และผู้รับทั้งหมดของข้อความล่าสุดในชุดข้อความนี้ โดยจะใส่อาร์กิวเมนต์หรือไม่ก็ได้ โดยอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML โปรดทราบว่าขนาดโดยรวมของอีเมล (รวมส่วนหัวทั้งหมด ยกเว้นไฟล์แนบ) ต้องไม่เกิน 20 KB

// Respond with HTML body text.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.replyAll("incapable of HTML", {
  htmlBody: "some HTML body text",
  noReply: true
});

พารามิเตอร์

ชื่อTypeคำอธิบาย
bodyStringเนื้อความของอีเมล
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูง ดังที่แสดงด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อTypeคำอธิบาย
ccStringรายชื่ออีเมลที่คั่นด้วยจุลภาคไปยังสำเนา
bccStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาคไปยังสำเนาลับ
htmlBodyStringหากตั้งค่าไว้ อุปกรณ์ที่แสดงผล HTML ได้จะใช้อาร์กิวเมนต์ดังกล่าวแทนอาร์กิวเมนต์เนื้อหาที่จำเป็น คุณเพิ่มช่อง inlineImages ในเนื้อหา HTML ได้หากมีรูปภาพในบรรทัดสำหรับอีเมล
nameStringชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
fromStringที่อยู่ที่ใช้ส่งอีเมล ซึ่งต้องเป็นค่าใดค่าหนึ่งที่ GmailApp.getAliases() แสดงผล
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)
noReplyBooleantrue หากควรส่งอีเมลจากอีเมลทั่วไปที่ไม่มีการตอบกลับเพื่อขัดขวางไม่ให้ผู้รับตอบอีเมล ตัวเลือกนี้จะทำได้เฉพาะบัญชี G Suite เท่านั้น ไม่ใช่สำหรับผู้ใช้ Gmail
attachmentsBlobSource[]อาร์เรย์ของไฟล์ที่จะส่งพร้อมกับอีเมล
inlineImagesObjectออบเจ็กต์ JavaScript ที่มีการแมปจากคีย์รูปภาพ (String) กับข้อมูลรูปภาพ (BlobSource) โดยจะถือว่ามีการใช้พารามิเตอร์ htmlBody และมีการอ้างอิงรูปภาพเหล่านี้ในรูปแบบ <img src="cid:imageKey" />

รีเทิร์น

GmailThread — ชุดข้อความนี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม