Class GmailApp

แอป Gmail

ให้สิทธิ์เข้าถึงชุดข้อความ ข้อความ และป้ายกำกับ Gmail

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
createDraft(recipient, subject, body)GmailDraftสร้างข้อความอีเมลฉบับร่าง
createDraft(recipient, subject, body, options)GmailDraftสร้างข้อความอีเมลฉบับร่างพร้อมอาร์กิวเมนต์ที่ไม่บังคับ
createLabel(name)GmailLabelสร้างป้ายกำกับผู้ใช้ใหม่ที่มีชื่อที่ระบุ
deleteLabel(label)GmailAppลบป้ายกำกับที่ระบุ
getAliases()String[]รับรายการอีเมลที่ตั้งค่าเป็นอีเมลแทนสําหรับบัญชีนี้ใน Gmail
getDraft(draftId)GmailDraftเรียกข้อมูลฉบับร่างข้อความอีเมลตามรหัส
getDraftMessages()GmailMessage[]ดึงข้อมูลข้อความร่างทั้งหมด
getDrafts()GmailDraft[]รับข้อความร่าง Gmail ทั้งหมด
getInboxThreads()GmailThread[]ดึงข้อมูลชุดข้อความทั้งหมดในกล่องจดหมายโดยไม่คำนึงถึงป้ายกำกับ
getInboxThreads(start, max)GmailThread[]ดึงข้อมูลชุดชุดข้อความในกล่องจดหมายโดยไม่คำนึงถึงป้ายกำกับ
getInboxUnreadCount()Integerรับจํานวนชุดข้อความที่ยังไม่อ่านในกล่องจดหมาย
getMessageById(id)GmailMessageรับข้อความตามรหัส
getMessagesForThread(thread)GmailMessage[]ดึงข้อมูลข้อความทั้งหมดในชุดข้อความที่ระบุ
getMessagesForThreads(threads)GmailMessage[][]ดึงข้อมูลข้อความทั้งหมดในชุดข้อความที่ระบุ
getPriorityInboxThreads()GmailThread[]ดึงข้อมูลชุดข้อความทั้งหมดในกล่องจดหมายสำคัญโดยไม่คำนึงถึงป้ายกำกับ
getPriorityInboxThreads(start, max)GmailThread[]เรียกข้อมูลชุดข้อความในกล่องจดหมายสำคัญช่วงหนึ่งโดยไม่คำนึงถึงป้ายกำกับ
getPriorityInboxUnreadCount()Integerรับจำนวนชุดข้อความที่ยังไม่อ่านในกล่องจดหมายสำคัญ
getSpamThreads()GmailThread[]ดึงข้อมูลชุดข้อความสแปมทั้งหมดโดยไม่คำนึงถึงป้ายกำกับ
getSpamThreads(start, max)GmailThread[]ดึงข้อมูลชุดข้อความสแปมโดยไม่คำนึงถึงป้ายกำกับ
getSpamUnreadCount()Integerรับจำนวนชุดข้อความที่ยังไม่อ่านซึ่งเป็นสแปม
getStarredThreads()GmailThread[]ดึงข้อมูลชุดข้อความที่ติดดาวทั้งหมดโดยไม่คำนึงถึงป้ายกำกับ
getStarredThreads(start, max)GmailThread[]ดึงข้อมูลชุดชุดข้อความที่ติดดาวโดยไม่คำนึงถึงป้ายกำกับ
getStarredUnreadCount()Integerรับจำนวนชุดข้อความที่ยังไม่ได้อ่านซึ่งมีการติดดาว
getThreadById(id)GmailThreadรับชุดข้อความตามรหัส
getTrashThreads()GmailThread[]ดึงข้อมูลชุดข้อความทั้งหมดในถังขยะโดยไม่คำนึงถึงป้ายกำกับ
getTrashThreads(start, max)GmailThread[]ดึงข้อมูลชุดชุดข้อความในถังขยะโดยไม่คำนึงถึงป้ายกำกับ
getUserLabelByName(name)GmailLabelดึงข้อมูลป้ายกำกับตามชื่อป้ายกำกับ
getUserLabels()GmailLabel[]เรียกข้อมูลรายการป้ายกำกับที่ผู้ใช้สร้างขึ้น
markMessageRead(message)GmailAppทำเครื่องหมายข้อความนี้ว่าอ่านแล้วและบังคับให้ข้อความรีเฟรช
markMessageUnread(message)GmailAppทำเครื่องหมายข้อความนี้ว่ายังไม่อ่านและบังคับให้ข้อความรีเฟรช
markMessagesRead(messages)GmailAppทำเครื่องหมายข้อความเหล่านี้ว่าอ่านแล้วและบังคับให้ข้อความรีเฟรช
markMessagesUnread(messages)GmailAppทำเครื่องหมายข้อความเหล่านี้ว่ายังไม่อ่านและบังคับให้ข้อความรีเฟรช
markThreadImportant(thread)GmailAppทำเครื่องหมายชุดข้อความนี้ว่าสำคัญและบังคับให้ชุดข้อความรีเฟรช
markThreadRead(thread)GmailAppทำเครื่องหมายชุดข้อความนี้ว่าอ่านแล้วและบังคับให้ชุดข้อความรีเฟรช
markThreadUnimportant(thread)GmailAppทำเครื่องหมายชุดข้อความนี้ว่าไม่สำคัญและบังคับให้ชุดข้อความรีเฟรช
markThreadUnread(thread)GmailAppทำเครื่องหมายชุดข้อความนี้ว่ายังไม่อ่านและบังคับให้ชุดข้อความรีเฟรช
markThreadsImportant(threads)GmailAppทำเครื่องหมายชุดข้อความเหล่านี้ว่าสำคัญและบังคับให้ชุดข้อความรีเฟรช
markThreadsRead(threads)GmailAppทำเครื่องหมายชุดข้อความเหล่านี้ว่าอ่านแล้วและบังคับให้ชุดข้อความรีเฟรช
markThreadsUnimportant(threads)GmailAppทำเครื่องหมายชุดข้อความเหล่านี้ว่าไม่สำคัญและบังคับให้ชุดข้อความรีเฟรช
markThreadsUnread(threads)GmailAppทำเครื่องหมายชุดข้อความเหล่านี้ว่ายังไม่อ่านและบังคับให้ชุดข้อความรีเฟรช
moveMessageToTrash(message)GmailAppย้ายข้อความไปที่ถังขยะและบังคับให้ข้อความรีเฟรช
moveMessagesToTrash(messages)GmailAppย้ายข้อความที่ระบุไปยังถังขยะและบังคับให้ข้อความรีเฟรช
moveThreadToArchive(thread)GmailAppย้ายชุดข้อความนี้ไปยังที่เก็บถาวรและบังคับให้ชุดข้อความรีเฟรช
moveThreadToInbox(thread)GmailAppย้ายชุดข้อความนี้ไปยังกล่องจดหมายและบังคับให้ชุดข้อความรีเฟรช
moveThreadToSpam(thread)GmailAppย้ายชุดข้อความนี้ไปยังโฟลเดอร์จดหมายขยะและบังคับให้ชุดข้อความรีเฟรช
moveThreadToTrash(thread)GmailAppย้ายชุดข้อความนี้ไปที่ถังขยะและบังคับให้ชุดข้อความรีเฟรช
moveThreadsToArchive(threads)GmailAppย้ายชุดข้อความเหล่านี้ไปยังที่เก็บถาวรและบังคับให้ชุดข้อความรีเฟรช
moveThreadsToInbox(threads)GmailAppย้ายชุดข้อความเหล่านี้ไปยังกล่องจดหมายและบังคับให้ชุดข้อความรีเฟรช
moveThreadsToSpam(threads)GmailAppย้ายชุดข้อความเหล่านี้ไปยังโฟลเดอร์จดหมายขยะและบังคับให้ชุดข้อความรีเฟรช
moveThreadsToTrash(threads)GmailAppย้ายชุดข้อความเหล่านี้ไปยังถังขยะและบังคับให้ชุดข้อความรีเฟรช
refreshMessage(message)GmailAppโหลดข้อความและสถานะที่เชื่อมโยงจาก Gmail อีกครั้ง (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะการอ่าน ฯลฯ มีการเปลี่ยนแปลง)
refreshMessages(messages)GmailAppโหลดข้อความและสถานะที่เชื่อมโยงจาก Gmail อีกครั้ง (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะอ่านแล้ว และอื่นๆ มีการเปลี่ยนแปลง)
refreshThread(thread)GmailAppโหลดชุดข้อความและสถานะที่เชื่อมโยงจาก Gmail อีกครั้ง (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะการอ่าน และอื่นๆ มีการเปลี่ยนแปลง)
refreshThreads(threads)GmailAppโหลดชุดข้อความและสถานะที่เชื่อมโยงจาก Gmail อีกครั้ง (มีประโยชน์ในกรณีที่ป้ายกำกับ สถานะการอ่าน และอื่นๆ มีการเปลี่ยนแปลง)
search(query)GmailThread[]ค้นหา Gmail ด้วยข้อความค้นหาที่ระบุ
search(query, start, max)GmailThread[]ค้นหา Gmail ด้วยข้อความค้นหาที่ระบุ
sendEmail(recipient, subject, body)GmailAppส่งข้อความอีเมล
sendEmail(recipient, subject, body, options)GmailAppส่งข้อความอีเมลพร้อมอาร์กิวเมนต์ที่ไม่บังคับ
setCurrentMessageAccessToken(accessToken)voidตั้งค่าโทเค็นการเข้าถึงข้อความปัจจุบันที่ช่วยให้สคริปต์เข้าถึงพร็อพเพอร์ตี้ GmailMessage ปัจจุบันได้
starMessage(message)GmailAppติดดาวข้อความนี้และบังคับให้ข้อความรีเฟรช
starMessages(messages)GmailAppติดดาวให้กับข้อความเหล่านี้และบังคับให้ข้อความรีเฟรช
unstarMessage(message)GmailAppนำดาวออกจากข้อความนี้และบังคับให้ข้อความรีเฟรช
unstarMessages(messages)GmailAppนำดาวออกจากข้อความเหล่านี้และบังคับให้ข้อความรีเฟรช

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

createDraft(recipient, subject, body)

สร้างข้อความอีเมลฉบับร่าง ขนาดของอีเมล (รวมถึงส่วนหัว) เกินโควต้า 

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

พารามิเตอร์

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

createDraft(recipient, subject, body, options)

สร้างข้อความอีเมลฉบับร่างพร้อมอาร์กิวเมนต์ที่ไม่บังคับ อีเมลอาจมีเนื้อหาแบบข้อความธรรมดาหรือ HTML ขนาดของอีเมล (รวมถึงส่วนหัว แต่ไม่รวมไฟล์แนบ) เกินโควต้า 

// Create a draft email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

พารามิเตอร์

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

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

createLabel(name)

สร้างป้ายกำกับผู้ใช้ใหม่ที่มีชื่อที่ระบุ 

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อป้ายกำกับใหม่

รีเทิร์น

GmailLabel — ป้ายกำกับที่สร้างใหม่

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

deleteLabel(label)

ลบป้ายกำกับที่ระบุ 

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
labelGmailLabelป้ายกำกับที่จะลบ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

getAliases()

รับรายการอีเมลที่ตั้งค่าเป็นอีเมลแทนสําหรับบัญชีนี้ใน Gmail

คุณส่งข้อความจากอีเมลแทนเหล่านี้ได้โดยใช้อาร์กิวเมนต์ "from" (ไม่บังคับ) 

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

รีเทิร์น

String[] — อาร์เรย์ของอีเมลแทนสำหรับบัญชีนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

getDraft(draftId)

เรียกข้อมูลฉบับร่างข้อความอีเมลตามรหัส

ใช้ร่วมกับ getId() ในฉบับร่างของ Gmail 

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
draftIdStringรหัสของร่างที่จะดึงข้อมูล

รีเทิร์น

GmailDraft — ฉบับร่างที่มีรหัสที่ระบุ

โยน

Error — หากไม่พบฉบับร่างที่มีรหัสที่ระบุ

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

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

  • https://mail.google.com/

getDraftMessages()

ดึงข้อมูลข้อความร่างทั้งหมด 

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

รีเทิร์น

GmailMessage[] — อาร์เรย์ของข้อความร่างใน Gmail

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

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

  • https://mail.google.com/

getDrafts()

รับข้อความร่าง Gmail ทั้งหมด 

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

รีเทิร์น

GmailDraft[] — อาร์เรย์ของข้อความร่าง Gmail

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

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

  • https://mail.google.com/

getInboxThreads()

ดึงข้อมูลชุดข้อความทั้งหมดในกล่องจดหมายโดยไม่คำนึงถึงป้ายกำกับ

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

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในกล่องจดหมาย

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

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

  • https://mail.google.com/

getInboxThreads(start, max)

ดึงข้อมูลชุดชุดข้อความในกล่องจดหมายโดยไม่คำนึงถึงป้ายกำกับ 

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของชุดข้อความแรกที่จะดึงข้อมูล
maxIntegerจำนวนชุดข้อความสูงสุดที่จะดึงข้อมูล

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในกล่องจดหมาย

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

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

  • https://mail.google.com/

getInboxUnreadCount()

รับจํานวนชุดข้อความที่ยังไม่อ่านในกล่องจดหมาย 

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

รีเทิร์น

Integer — จำนวนชุดข้อความในกล่องจดหมายที่มีข้อความที่ยังไม่อ่าน

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

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

  • https://mail.google.com/

getMessageById(id)

รับข้อความตามรหัส

ใช้ร่วมกับ getId() ในข้อความ Gmail 

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของข้อความที่จะดึงข้อมูล

รีเทิร์น

GmailMessage — ข้อความที่มีรหัสที่ระบุ

โยน

Error — หากไม่พบข้อความที่มีรหัสที่ระบุ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

getMessagesForThread(thread)

ดึงข้อมูลข้อความทั้งหมดในชุดข้อความที่ระบุ 

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะดึงข้อมูล

รีเทิร์น

GmailMessage[] — อาร์เรย์ของข้อความที่เกี่ยวข้องกับชุดข้อความนี้

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

getMessagesForThreads(threads)

ดึงข้อมูลข้อความทั้งหมดในชุดข้อความที่ระบุ 

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]ชุดข้อความที่จะดึงข้อมูล

รีเทิร์น

GmailMessage[][] — อาร์เรย์ของอาร์เรย์ข้อความ โดยที่แต่ละรายการในอาร์เรย์ด้านนอกจะสอดคล้องกับชุดข้อความ และอาร์เรย์ด้านในจะมีข้อความในชุดข้อความนั้น

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

getPriorityInboxThreads()

ดึงข้อมูลชุดข้อความทั้งหมดในกล่องจดหมายสำคัญโดยไม่คำนึงถึงป้ายกำกับ

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

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในกล่องจดหมายสำคัญ

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

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

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

เรียกข้อมูลชุดข้อความในกล่องจดหมายสำคัญช่วงหนึ่งโดยไม่คำนึงถึงป้ายกำกับ 

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของชุดข้อความแรกที่จะดึงข้อมูล
maxIntegerจำนวนชุดข้อความสูงสุดที่จะดึงข้อมูล

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในกล่องจดหมายสำคัญ

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

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

  • https://mail.google.com/

getPriorityInboxUnreadCount()

รับจำนวนชุดข้อความที่ยังไม่อ่านในกล่องจดหมายสำคัญ 

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

รีเทิร์น

Integer — จำนวนชุดข้อความในกล่องจดหมายสำคัญที่มีข้อความที่ยังไม่อ่าน

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

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

  • https://mail.google.com/

getSpamThreads()

ดึงข้อมูลชุดข้อความสแปมทั้งหมดโดยไม่คำนึงถึงป้ายกำกับ

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

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในโฟลเดอร์จดหมายขยะ

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

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

  • https://mail.google.com/

getSpamThreads(start, max)

ดึงข้อมูลชุดข้อความสแปมโดยไม่คำนึงถึงป้ายกำกับ 

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของชุดข้อความแรกที่จะดึงข้อมูล
maxIntegerจำนวนชุดข้อความสูงสุดที่จะดึงข้อมูล

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในโฟลเดอร์จดหมายขยะ

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

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

  • https://mail.google.com/

getSpamUnreadCount()

รับจำนวนชุดข้อความที่ยังไม่อ่านซึ่งเป็นสแปม 

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

รีเทิร์น

Integer — จำนวนชุดข้อความสแปมที่มีข้อความที่ยังไม่อ่าน

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

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

  • https://mail.google.com/

getStarredThreads()

ดึงข้อมูลชุดข้อความที่ติดดาวทั้งหมดโดยไม่คำนึงถึงป้ายกำกับ

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

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ที่ติดดาว

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

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

  • https://mail.google.com/

getStarredThreads(start, max)

ดึงข้อมูลชุดชุดข้อความที่ติดดาวโดยไม่คำนึงถึงป้ายกำกับ 

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของชุดข้อความแรกที่จะดึงข้อมูล
maxIntegerจำนวนชุดข้อความสูงสุดที่จะดึงข้อมูล

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ที่ติดดาว

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

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

  • https://mail.google.com/

getStarredUnreadCount()

รับจำนวนชุดข้อความที่ยังไม่ได้อ่านซึ่งมีการติดดาว 

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

รีเทิร์น

Integer — จำนวนชุดข้อความที่ติดดาวซึ่งมีข้อความที่ยังไม่อ่าน

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

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

  • https://mail.google.com/

getThreadById(id)

รับชุดข้อความตามรหัส

ใช้ร่วมกับ getId() ในชุดข้อความ Gmail 

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(
    firstThread.getFirstMessageSubject() ===
        threadById.getFirstMessageSubject(),
);

พารามิเตอร์

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

รีเทิร์น

GmailThread — แสดงชุดข้อความที่มีรหัสที่ระบุ หรือ null หากไม่พบ

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

getTrashThreads()

ดึงข้อมูลชุดข้อความทั้งหมดในถังขยะโดยไม่คำนึงถึงป้ายกำกับ

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

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในถังขยะ

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

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

  • https://mail.google.com/

getTrashThreads(start, max)

ดึงข้อมูลชุดชุดข้อความในถังขยะโดยไม่คำนึงถึงป้ายกำกับ 

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของชุดข้อความแรกที่จะดึงข้อมูล
maxIntegerจำนวนชุดข้อความสูงสุดที่จะดึงข้อมูล

รีเทิร์น

GmailThread[] — อาร์เรย์ของชุดข้อความ Gmail ในถังขยะ

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

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

  • https://mail.google.com/

getUserLabelByName(name)

ดึงข้อมูลป้ายกำกับตามชื่อป้ายกำกับ 

const labelObject = GmailApp.getUserLabelByName('myLabel');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของป้ายกำกับที่จะดึงข้อมูล

รีเทิร์น

GmailLabel — ป้ายกำกับ Gmail ที่มีชื่อที่ระบุ

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

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

  • https://mail.google.com/

getUserLabels()

เรียกข้อมูลรายการป้ายกำกับที่ผู้ใช้สร้างขึ้น 

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

รีเทิร์น

GmailLabel[] — อาร์เรย์ของป้ายกำกับที่ผู้ใช้สร้างขึ้น

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

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

  • https://mail.google.com/

markMessageRead(message)

ทำเครื่องหมายข้อความนี้ว่าอ่านแล้วและบังคับให้ข้อความรีเฟรช 

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

พารามิเตอร์

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

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markMessageUnread(message)

ทำเครื่องหมายข้อความนี้ว่ายังไม่อ่านและบังคับให้ข้อความรีเฟรช 

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messageGmailMessageข้อความที่จะทําเครื่องหมายว่ายังไม่อ่าน

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markMessagesRead(messages)

ทำเครื่องหมายข้อความเหล่านี้ว่าอ่านแล้วและบังคับให้ข้อความรีเฟรช 

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messagesGmailMessage[]อาร์เรย์ของข้อความที่จะทําเครื่องหมายว่าอ่านแล้ว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markMessagesUnread(messages)

ทำเครื่องหมายข้อความเหล่านี้ว่ายังไม่อ่านและบังคับให้ข้อความรีเฟรช 

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messagesGmailMessage[]อาร์เรย์ของข้อความที่จะทําเครื่องหมายว่ายังไม่อ่าน

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadImportant(thread)

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

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะทําเครื่องหมายว่าสําคัญ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadRead(thread)

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

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะทําเครื่องหมายว่าอ่านแล้ว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadUnimportant(thread)

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

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะทําเครื่องหมายว่าไม่สําคัญ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadUnread(thread)

ทำเครื่องหมายชุดข้อความนี้ว่ายังไม่อ่านและบังคับให้ชุดข้อความรีเฟรช 

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะทําเครื่องหมายว่ายังไม่อ่าน

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadsImportant(threads)

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

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะทําเครื่องหมายว่าสําคัญ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadsRead(threads)

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

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะทําเครื่องหมายว่าอ่านแล้ว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadsUnimportant(threads)

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

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะทําเครื่องหมายว่าไม่สําคัญ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

markThreadsUnread(threads)

ทำเครื่องหมายชุดข้อความเหล่านี้ว่ายังไม่อ่านและบังคับให้ชุดข้อความรีเฟรช 

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะทําเครื่องหมายว่ายังไม่อ่าน

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveMessageToTrash(message)

ย้ายข้อความไปที่ถังขยะและบังคับให้ข้อความรีเฟรช 

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

พารามิเตอร์

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

รีเทิร์น

GmailApp — บริการ Gmail (มีประโยชน์สำหรับการต่อเชื่อม)

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveMessagesToTrash(messages)

ย้ายข้อความที่ระบุไปยังถังขยะและบังคับให้ข้อความรีเฟรช 

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messagesGmailMessage[]ข้อความที่จะทิ้ง

รีเทิร์น

GmailApp — บริการ Gmail (มีประโยชน์สำหรับการต่อเชื่อม)

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadToArchive(thread)

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

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะเก็บ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadToInbox(thread)

ย้ายชุดข้อความนี้ไปยังกล่องจดหมายและบังคับให้ชุดข้อความรีเฟรช 

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

พารามิเตอร์

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

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadToSpam(thread)

ย้ายชุดข้อความนี้ไปยังโฟลเดอร์จดหมายขยะและบังคับให้ชุดข้อความรีเฟรช 

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะย้ายไปยังโฟลเดอร์จดหมายขยะ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadToTrash(thread)

ย้ายชุดข้อความนี้ไปที่ถังขยะและบังคับให้ชุดข้อความรีเฟรช 

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadชุดข้อความที่จะทิ้ง

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadsToArchive(threads)

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

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะเก็บ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadsToInbox(threads)

ย้ายชุดข้อความเหล่านี้ไปยังกล่องจดหมายและบังคับให้ชุดข้อความรีเฟรช 

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะย้ายไปยังกล่องจดหมาย

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadsToSpam(threads)

ย้ายชุดข้อความเหล่านี้ไปยังโฟลเดอร์จดหมายขยะและบังคับให้ชุดข้อความรีเฟรช 

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะย้ายไปยังโฟลเดอร์จดหมายขยะ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

moveThreadsToTrash(threads)

ย้ายชุดข้อความเหล่านี้ไปยังถังขยะและบังคับให้ชุดข้อความรีเฟรช 

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]อาร์เรย์ของชุดข้อความที่จะทิ้ง

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

refreshMessage(message)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messageGmailMessageข้อความที่จะรีเฟรช

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

refreshMessages(messages)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messagesGmailMessage[]ข้อความที่จะรีเฟรช

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

refreshThread(thread)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadGmailThreadรีเฟรชชุดข้อความ

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

refreshThreads(threads)

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

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

พารามิเตอร์

ชื่อประเภทคำอธิบาย
threadsGmailThread[]ชุดข้อความที่จะรีเฟรช

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

search(query)

ค้นหา Gmail ด้วยข้อความค้นหาที่ระบุ

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

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringคําค้นหาตามที่พิมพ์ลงใน Gmail

รีเทิร์น

GmailThread[] — อาร์เรย์ชุดข้อความ Gmail ที่ตรงกับการค้นหานี้

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

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

  • https://mail.google.com/

search(query, start, max)

ค้นหา Gmail ด้วยข้อความค้นหาที่ระบุ 

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty
// array.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringคําค้นหาตามที่พิมพ์ลงใน Gmail
startIntegerดัชนีของชุดข้อความเริ่มต้น
maxIntegerจำนวนชุดข้อความสูงสุดที่จะแสดง

รีเทิร์น

GmailThread[] — อาร์เรย์ชุดข้อความ Gmail ที่ตรงกับการค้นหานี้

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

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

  • https://mail.google.com/

sendEmail(recipient, subject, body)

ส่งข้อความอีเมล ขนาดของอีเมล (รวมถึงส่วนหัว) เกินโควต้า 

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
recipientStringรายการอีเมลที่คั่นด้วยคอมมา
subjectStringเรื่องอีเมล (สูงสุด 250 อักขระ)
bodyStringเนื้อหาของอีเมล

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

sendEmail(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    'mike@example.com',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

พารามิเตอร์

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

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

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

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

setCurrentMessageAccessToken(accessToken)

ตั้งค่าโทเค็นการเข้าถึงข้อความปัจจุบันที่ช่วยให้สคริปต์เข้าถึงพร็อพเพอร์ตี้ GmailMessage ปัจจุบันได้

เฉพาะโปรเจ็กต์ส่วนเสริมของ Google Workspace ที่ใช้ขอบเขตข้อความปัจจุบันของ Gmail เท่านั้นที่ต้องใช้วิธีการนี้ 

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
accessTokenStringโทเค็นการเข้าถึงชั่วคราวที่ได้รับจากออบเจ็กต์เหตุการณ์การดำเนินการของส่วนเสริม Gmail

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

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

  • https://mail.google.com/

starMessage(message)

ติดดาวข้อความนี้และบังคับให้ข้อความรีเฟรช 

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messageGmailMessageข้อความที่จะติดดาว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

starMessages(messages)

ติดดาวให้กับข้อความเหล่านี้และบังคับให้ข้อความรีเฟรช 

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messagesGmailMessage[]อาร์เรย์ของข้อความที่จะติดดาว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

unstarMessage(message)

นำดาวออกจากข้อความนี้และบังคับให้ข้อความรีเฟรช 

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messageGmailMessageข้อความที่จะเลิกติดดาว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

unstarMessages(messages)

นำดาวออกจากข้อความเหล่านี้และบังคับให้ข้อความรีเฟรช 

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
messagesGmailMessage[]อาร์เรย์ของข้อความที่จะเลิกติดดาว

รีเทิร์น

GmailApp — บริการ Gmail ซึ่งมีประโยชน์สำหรับการต่อเชื่อม

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

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

  • https://mail.google.com/

ดูเพิ่มเติม

วิธีการที่เลิกใช้งาน