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รับผู้รับที่ส่งสำเนาถึงในข้อความนี้โดยคั่นด้วยคอมมา
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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 ได้จะใช้ค่านี้แทนอาร์กิวเมนต์ body ที่ต้องระบุ คุณสามารถเพิ่มช่อง 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 ได้จะใช้ค่านี้แทนอาร์กิวเมนต์ body ที่ต้องระบุ คุณสามารถเพิ่มช่อง 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 ขนาดของอีเมล (รวมถึงส่วนหัว) เกินโควต้า

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 ได้จะใช้ค่านี้แทนอาร์กิวเมนต์ body ที่ต้องระบุ คุณสามารถเพิ่มช่อง 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()

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

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 ของเนื้อหาข้อความนี้

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getDate()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 จากชื่อส่วนหัว

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const 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()

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

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

รีเทิร์น

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


getPlainBody()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getSubject()

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


getThread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

รีเทิร์น

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

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

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

  • https://mail.google.com/

isInChats()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

รีเทิร์น

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


isInInbox()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 ในกรณีอื่นๆ

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

รีเทิร์น

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


isStarred()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

รีเทิร์น

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


isUnread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

รีเทิร์น

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

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

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

  • https://mail.google.com/

markRead()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้มีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


markUnread()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้มีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


moveToTrash()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้มีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


refresh()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 ได้จะใช้ค่านี้แทนอาร์กิวเมนต์ body ที่ต้องระบุ คุณสามารถเพิ่มช่อง 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
attachmentsBlobSource[]อาร์เรย์ของไฟล์ที่จะส่งไปกับอีเมล
bccStringรายการอีเมลที่ส่งสำเนาลับซึ่งคั่นด้วยคอมมา
ccStringรายการอีเมลที่คั่นด้วยคอมมาเพื่อส่งสำเนา
fromStringอีเมลที่ควรส่ง ซึ่งต้องเป็นค่าใดค่าหนึ่งจากค่าที่ GmailApp.getAliases() แสดง
htmlBodyStringเมื่อตั้งค่าแล้ว อุปกรณ์ที่แสดงผล HTML ได้จะใช้ค่านี้แทนอาร์กิวเมนต์ body ที่ต้องระบุ คุณสามารถเพิ่มช่อง 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()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้มีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม


unstar()

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

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

รีเทิร์น

GmailMessage — GmailMessage นี้มีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม