Class GmailMessage

GmailMessage

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

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
createDraftReply(body)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ
createDraftReply(body, options)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ พร้อมด้วยอาร์กิวเมนต์ที่ไม่บังคับ
createDraftReplyAll(body)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งโดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมดของข้อความนี้
createDraftReplyAll(body, options)GmailDraftสร้างข้อความร่างที่ตอบกลับผู้ส่งข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมด โดยมีอาร์กิวเมนต์หรือไม่ก็ได้
forward(recipient)GmailMessageส่งต่อข้อความนี้ไปยังผู้รับรายใหม่
forward(recipient, options)GmailMessageส่งต่อข้อความนี้ไปยังผู้รับใหม่โดยเลือกอาร์กิวเมนต์หรือไม่ก็ได้
getAttachments()GmailAttachment[]รับไฟล์แนบทั้งหมดของข้อความนี้
getAttachments(options)GmailAttachment[]รับไฟล์แนบทั้งหมดของข้อความนี้
getBcc()Stringรับสำเนาลับผู้รับที่คั่นด้วยคอมมาในข้อความนี้
getBody()Stringรับเนื้อหา HTML ของเนื้อหาของข้อความนี้
getCc()Stringรับสำเนาถึงผู้รับที่คั่นด้วยจุลภาคในข้อความนี้
getDate()Dateรับข้อมูลวันที่และเวลาของข้อความนี้
getFrom()Stringรับผู้ส่งข้อความนี้
getHeader(name)Stringรับค่าของส่วนหัว RFC 2822 ตามชื่อส่วนหัว
getId()Stringรับรหัสของข้อความนี้
getPlainBody()Stringรับเนื้อหาของข้อความนี้โดยไม่มีการจัดรูปแบบ HTML
getRawContent()Stringรับเนื้อหาดิบของข้อความนี้
getReplyTo()Stringรับที่อยู่สำหรับตอบกลับของข้อความนี้ (โดยปกติจะเป็นผู้ส่ง)
getSubject()Stringรับหัวเรื่องของข้อความนี้
getThread()GmailThreadรับชุดข้อความที่มีข้อความนี้
getTo()Stringรับผู้รับข้อความนี้โดยคั่นด้วยเครื่องหมายจุลภาค
isDraft()Booleanรับข้อมูลว่าข้อความนี้เป็นฉบับร่างหรือไม่
isInChats()Booleanรับข้อมูลว่าข้อความนี้เป็นแชทหรือไม่
isInInbox()Booleanได้รับว่าข้อความนี้อยู่ในกล่องจดหมายหรือไม่
isInPriorityInbox()Booleanแสดงผล true หากข้อความนี้อยู่ในกล่องจดหมายสำคัญ หรือจะแสดงผล false ในกรณีอื่นๆ
isInTrash()Booleanรับข้อมูลว่าข้อความนี้อยู่ในถังขยะหรือไม่
isStarred()Booleanรับข้อมูลว่าข้อความนี้ได้รับการติดดาวหรือไม่
isUnread()Booleanรับข้อมูลว่าข้อความนี้ยังไม่อ่านหรือไม่
markRead()GmailMessageทำเครื่องหมายข้อความว่าอ่านแล้ว
markUnread()GmailMessageทำเครื่องหมายข้อความว่ายังไม่อ่าน
moveToTrash()GmailMessageย้ายข้อความไปที่ถังขยะ
refresh()GmailMessageโหลดข้อความนี้และสถานะที่เกี่ยวข้องจาก Gmail ซ้ำ (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะการอ่าน ฯลฯ มีการเปลี่ยนแปลง)
reply(body)GmailMessageตอบกลับผู้ส่งข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ
reply(body, options)GmailMessageตอบกลับผู้ส่งข้อความนี้โดยใช้ที่อยู่สำหรับตอบกลับ พร้อมระบุอาร์กิวเมนต์หรือไม่ก็ได้
replyAll(body)GmailMessageตอบกลับผู้ส่งโดยใช้ที่อยู่สำหรับตอบกลับและผู้รับทั้งหมดของข้อความนี้
replyAll(body, options)GmailMessageตอบกลับผู้ส่งข้อความนี้โดยใช้ที่อยู่ตอบกลับและผู้รับทั้งหมด พร้อมด้วยอาร์กิวเมนต์ที่ไม่บังคับ
star()GmailMessageติดดาวข้อความ
unstar()GmailMessageยกเลิกการติดดาวข้อความ

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

createDraftReply(body)

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

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.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];
var message = firstThread.getMessages()[0];
message.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 response to all recipients (except those bcc'd) with an acknowledgment.
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 response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.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/

ดูเพิ่มเติม


forward(recipient)

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

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

พารามิเตอร์

ชื่อTypeคำอธิบาย
recipientStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาค

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


forward(recipient, options)

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

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

พารามิเตอร์

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

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getAttachments()

รับไฟล์แนบทั้งหมดของข้อความนี้

รีเทิร์น

GmailAttachment[] — อาร์เรย์ของไฟล์แนบ Blob สำหรับข้อความนี้

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

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

  • https://mail.google.com/

getAttachments(options)

รับไฟล์แนบทั้งหมดของข้อความนี้

พารามิเตอร์

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

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

ชื่อTypeคำอธิบาย
includeInlineImagesBooleantrue หากอาร์เรย์ที่แสดงผลของไฟล์แนบ Blob ควรมีรูปภาพแบบในบรรทัด (ค่าเริ่มต้นคือ true)
includeAttachmentsBooleantrue หากอาร์เรย์ที่แสดงผลของไฟล์แนบ Blob ควรมีไฟล์แนบปกติ (ไม่แทรกในบรรทัด) (ค่าเริ่มต้นคือ true)

รีเทิร์น

GmailAttachment[] — อาร์เรย์ของไฟล์แนบ Blob สำหรับข้อความนี้

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

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

  • https://mail.google.com/

getBcc()

รับสำเนาลับผู้รับที่คั่นด้วยคอมมาในข้อความนี้

ค่านี้ว่างเปล่าสำหรับข้อความที่ได้รับทั้งหมดตามคำจำกัดความ

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

รีเทิร์น

String — ผู้รับที่คั่นด้วยจุลภาคในสำเนาลับของข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getBody()

รับเนื้อหา HTML ของเนื้อหาของข้อความนี้

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

รีเทิร์น

String — เนื้อหาเนื้อหาของข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getCc()

รับสำเนาถึงผู้รับที่คั่นด้วยจุลภาคในข้อความนี้

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

รีเทิร์น

String — สำเนาผู้รับที่คั่นด้วยคอมมาในข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getDate()

รับข้อมูลวันที่และเวลาของข้อความนี้

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

รีเทิร์น

Date — วันที่และเวลาของข้อความนี้

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

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

  • https://mail.google.com/

getFrom()

รับผู้ส่งข้อความนี้

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

รีเทิร์น

String — อีเมลของผู้ส่งข้อความ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getHeader(name)

รับค่าของส่วนหัว RFC 2822 ตามชื่อส่วนหัว

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อของส่วนหัว RFC โดยไม่มีเครื่องหมายโคลอนแยกออกจากค่า

รีเทิร์น

String — ค่าของส่วนหัวหรือสตริงว่างหากไม่มีส่วนหัวในข้อความ

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

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

  • https://mail.google.com/

getId()

รับรหัสของข้อความนี้

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

รีเทิร์น

String — รหัสข้อความ


getPlainBody()

รับเนื้อหาของข้อความนี้โดยไม่มีการจัดรูปแบบ HTML กรณีนี้ซับซ้อนกว่า getBody() และใช้เวลานานกว่า

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

รีเทิร์น

String — เนื้อหาทั่วไปของข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getRawContent()

รับเนื้อหาดิบของข้อความนี้ ซึ่งจะเหมือนกับ "แสดงต้นฉบับ" ใน UI ของ Gmail

รีเทิร์น

String — เนื้อหาดิบของข้อความนี้

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

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

  • https://mail.google.com/

getReplyTo()

รับที่อยู่สำหรับตอบกลับของข้อความนี้ (โดยปกติจะเป็นผู้ส่ง)

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

รีเทิร์น

String — อีเมลสำหรับตอบกลับ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getSubject()

รับหัวเรื่องของข้อความนี้

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

รีเทิร์น

String — หัวเรื่องของข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getThread()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

รีเทิร์น

GmailThread — GmailThread ที่มีข้อความนี้

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

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

  • https://mail.google.com/

getTo()

รับผู้รับข้อความนี้โดยคั่นด้วยเครื่องหมายจุลภาค

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

รีเทิร์น

String — ผู้รับข้อความนี้ซึ่งคั่นด้วยเครื่องหมายจุลภาค

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


isDraft()

รับข้อมูลว่าข้อความนี้เป็นฉบับร่างหรือไม่

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

รีเทิร์น

Boolean — ข้อความนี้เป็นฉบับร่างหรือไม่

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

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

  • https://mail.google.com/

isInChats()

รับข้อมูลว่าข้อความนี้เป็นแชทหรือไม่

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

รีเทิร์น

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


isInInbox()

ได้รับว่าข้อความนี้อยู่ในกล่องจดหมายหรือไม่

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

รีเทิร์น

Boolean — ระบุว่าข้อความนี้อยู่ในกล่องจดหมายหรือไม่

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

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

  • https://mail.google.com/

isInPriorityInbox()

แสดงผล true หากข้อความนี้อยู่ในกล่องจดหมายสำคัญ หรือจะแสดงผล false ในกรณีอื่นๆ

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

รีเทิร์น

Boolean — ข้อความนี้อยู่ในกล่องจดหมายสำคัญหรือไม่

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

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

  • https://mail.google.com/

isInTrash()

รับข้อมูลว่าข้อความนี้อยู่ในถังขยะหรือไม่

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

รีเทิร์น

Boolean — มีข้อความนี้อยู่ในถังขยะหรือไม่


isStarred()

รับข้อมูลว่าข้อความนี้ได้รับการติดดาวหรือไม่

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

รีเทิร์น

Boolean — มีการติดดาวข้อความนี้หรือไม่


isUnread()

รับข้อมูลว่าข้อความนี้ยังไม่อ่านหรือไม่

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

รีเทิร์น

Boolean — สถานะยังไม่อ่านของข้อความนี้

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

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

  • https://mail.google.com/

markRead()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


markUnread()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


moveToTrash()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


refresh()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

รีเทิร์น

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

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

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

  • https://mail.google.com/

reply(body)

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


reply(body, options)

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

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

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

พารามิเตอร์

ชื่อ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ชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
noReplyBooleantrue หากควรส่งอีเมลจากอีเมลทั่วไปที่ไม่มีการตอบกลับเพื่อขัดขวางไม่ให้ผู้รับตอบอีเมล ตัวเลือกนี้จะทำได้เฉพาะบัญชี Google Workspace เท่านั้น ไม่ใช่สำหรับผู้ใช้ Gmail
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)
subjectStringบรรทัดเรื่องใหม่สำหรับอีเมล มีอักขระได้สูงสุด 250 ตัว

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


replyAll(body)

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

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

พารามิเตอร์

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

รีเทิร์น

GmailMessage — ข้อความนี้เป็นประโยชน์สำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


replyAll(body, options)

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

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

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

พารามิเตอร์

ชื่อ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ชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
noReplyBooleantrue หากควรส่งอีเมลจากอีเมลทั่วไปที่ไม่มีการตอบกลับเพื่อขัดขวางไม่ให้ผู้รับตอบอีเมล ตัวเลือกนี้จะทำได้เฉพาะบัญชี Google Workspace เท่านั้น ไม่ใช่สำหรับผู้ใช้ Gmail
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)
subjectStringบรรทัดเรื่องใหม่สำหรับอีเมล มีอักขระได้สูงสุด 250 ตัว

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


star()

ติดดาวข้อความ

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

รีเทิร์น

GmailMessage — GmailMessage นี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


unstar()

ยกเลิกการติดดาวข้อความ

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

รีเทิร์น

GmailMessage — GmailMessage นี้เหมาะสำหรับการทำเชน

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

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

  • https://mail.google.com/

ดูเพิ่มเติม