Class GmailMessage

Gmail ข้อความ

ข้อความในบัญชี 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รับผู้รับที่คั่นด้วยคอมมา cc'd ในข้อความนี้
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");

พารามิเตอร์

ชื่อประเภทคำอธิบาย
bodyStringเนื้อความของอีเมล

ไปกลับ

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


createDraftReply(body, options)

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

ซึ่งอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดอีเมล (รวมถึงส่วนหัว) คือ quota limited

// 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"
});

พารามิเตอร์

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

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

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

ไปกลับ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
bodyStringเนื้อความของอีเมล

ไปกลับ

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


createDraftReplyAll(body, options)

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

ซึ่งอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดอีเมล (รวมถึงส่วนหัว) คือ quota limited

// 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"
});

พารามิเตอร์

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

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

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

ไปกลับ

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

พารามิเตอร์

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

ไปกลับ

GmailMessage — ข้อความนี้มีประโยชน์สําหรับเชนธุรกิจ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


forward(recipient, options)

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

ซึ่งอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดของอีเมล (รวมส่วนหัว) คือ quota limited

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
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บรรทัดเรื่องใหม่สําหรับอีเมล

ไปกลับ

GmailMessage — ข้อความนี้มีประโยชน์สําหรับเชนธุรกิจ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getAttachments()

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

ไปกลับ

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

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

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

  • https://mail.google.com/

getAttachments(options)

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
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 — ผู้รับที่คั่นด้วยคอมมาจะส่งสําเนาลับถึง ##99;d ในข้อความนี้

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

สคริปต์ที่ใช้วิธีนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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()

รับผู้รับที่คั่นด้วยคอมมา cc'd ในข้อความนี้

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 — ผู้รับที่คั่นด้วยคอมมา cc'd ในข้อความนี้

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

สคริปต์ที่ใช้วิธีนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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.

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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)

ตอบผู้ส่งข้อความนี้โดยใช้อีเมลตอบกลับ ขนาดของอีเมล (รวมส่วนหัว) คือ quota limited

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
bodyStringเนื้อความของอีเมล

ไปกลับ

GmailMessage — ข้อความนี้มีประโยชน์สําหรับเชนธุรกิจ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


reply(body, options)

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

ซึ่งอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดของอีเมล (รวมส่วนหัว) คือ quota limited

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
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บรรทัดเรื่องใหม่สําหรับอีเมล

ไปกลับ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
bodyStringเนื้อความของอีเมล

ไปกลับ

GmailMessage — ข้อความนี้มีประโยชน์สําหรับเชนธุรกิจ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


replyAll(body, options)

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

ซึ่งอีเมลจะมีได้ทั้งข้อความธรรมดาและเนื้อหา HTML ขนาดของอีเมล (รวมส่วนหัว) คือ quota limited

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
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/

ดูเพิ่มเติม