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

พารามิเตอร์

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
attachmentsBlobSource[]CANNOT TRANSLATE อาร์เรย์ของไฟล์ที่จะส่งพร้อมอีเมล
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");

พารามิเตอร์

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
attachmentsBlobSource[]CANNOT TRANSLATE อาร์เรย์ของไฟล์ที่จะส่งพร้อมอีเมล
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");

พารามิเตอร์

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
attachmentsBlobSource[]CANNOT TRANSLATE อาร์เรย์ของไฟล์ที่จะส่งพร้อมอีเมล
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)

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

พารามิเตอร์

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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 — ชุดข้อความ Gmail ที่มีข้อความนี้

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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");

พารามิเตอร์

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
attachmentsBlobSource[]CANNOT TRANSLATE อาร์เรย์ของไฟล์ที่จะส่งพร้อมอีเมล
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");

พารามิเตอร์

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

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
attachmentsBlobSource[]CANNOT TRANSLATE อาร์เรย์ของไฟล์ที่จะส่งพร้อมอีเมล
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/

ดูเพิ่มเติม