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	依 ID 擷取電子郵件草稿。
getDraftMessages()	GmailMessage[]	擷取所有草稿郵件。
getDrafts()	GmailDraft[]	取得所有 Gmail 草稿郵件。
getInboxThreads()	GmailThread[]	不分標籤，擷取所有收件匣會話串。
getInboxThreads(start, max)	GmailThread[]	無論標籤為何，皆可擷取收件匣會話串的範圍。
getInboxUnreadCount()	Integer	取得收件匣中未讀的討論串數量。
getMessageById(id)	GmailMessage	依 ID 取得郵件。
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	依據 ID 取得會話串。
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	移除這些訊息的星號，並強制重新整理訊息。

已淘汰的方法

方法	傳回類型	簡短說明
getChatThreads()	GmailThread[]	在 Google 在今年稍晚將所有傳統版 Hangouts 使用者轉換至 Chat 之前，這項操作會擷取所有傳統版 Google Hangouts 會話串和 Google Chat 會話串。
getChatThreads(start, max)	GmailThread[]	取得一系列傳統版 Google Hangouts 會話串流和 Google Chat 會話串流，直到 Google 在今年稍晚將所有傳統版 Hangouts 使用者轉換至 Chat 為止。

內容詳盡的說明文件

createDraft(recipient, subject, body)

建立電子郵件草稿。電子郵件大小 (包括標頭) 受到配額限制。

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

參數

名稱	類型	說明
recipient	String	以半形逗號分隔的電子郵件地址清單
subject	String	電子郵件主旨
body	String	電子郵件內文

回攻員

GmailDraft：新建立的 GmailDraft

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• createDraft(recipient, subject, body, options)

---

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(
    '[e-mail]',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

參數

名稱	類型	說明
recipient	String	收件者的地址
subject	String	主旨行
body	String	電子郵件內文
options	Object	指定進階參數的 JavaScript 物件，如下所列：

進階參數

名稱	類型	說明
attachments	BlobSource[]	要隨電子郵件傳送的檔案陣列
bcc	String	以半形逗號分隔的電子郵件地址清單 (用於副本收件人)
cc	String	以半形逗號分隔的電子郵件地址清單 (用於副本收件者)
from	String	電子郵件應傳送自的地址，必須是 getAliases() 傳回的其中一個值
htmlBody	String	如果已設定，則可轉換為可轉換 HTML 的裝置，而非使用必要的 body 引數；如果您為電子郵件內嵌圖片，則可在 HTML 主體中新增選用的 inlineImages 欄位
inlineImages	Object	JavaScript 物件，其中包含圖片鍵 (String) 與圖片資料 (BlobSource) 的對應關係；這項操作假設您會使用 htmlBody 參數，並以 <img src="cid:imageKey" /> 格式包含這些圖片的參照
name	String	電子郵件寄件者的名稱 (預設為使用者名稱)
replyTo	String	做為預設回覆地址的電子郵件地址 (預設值：使用者的電子郵件地址)

回攻員

GmailDraft：新建立的 GmailDraft

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• createDraft(recipient, subject, body)

---

createLabel(name)

建立指定名稱的新使用者標籤。

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

參數

名稱	類型	說明
name	String	新標籤的名稱

回攻員

GmailLabel - 新建立的標籤

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• deleteLabel(label)

---

deleteLabel(label)

刪除指定的標籤。

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

參數

名稱	類型	說明
label	GmailLabel	要刪除的標籤

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• createLabel(name)

---

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[]：這個帳戶的別名陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

依 ID 擷取電子郵件草稿。

在 Gmail 草稿中，請搭配使用 getId()。

// 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(),
);

參數

名稱	類型	說明
draftId	String	要擷取的草稿 ID

回攻員

GmailDraft：具有指定 ID 的草稿

擲回

Error：如果找不到指定 ID 的草稿

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getDraftMessages()

擷取所有草稿郵件。

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

回攻員

GmailMessage[]：Gmail 草稿郵件的陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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 草稿郵件陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getInboxThreads()

擷取所有收件匣會話串，不限標籤。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並指定要在每次呼叫中擷取的執行緒範圍。

// 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 主題的陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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());
}

參數

名稱	類型	說明
start	Integer	要擷取的第一個執行緒的索引
max	Integer	要擷取的執行緒數量上限

回攻員

GmailThread[]：收件匣中 Gmail 主題的陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getInboxUnreadCount()

取得收件匣中未讀的討論串數量。

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

回攻員

Integer：收件匣中含有未讀郵件的會話串數量

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getMessageById(id)

依 ID 取得郵件。

在 Gmail 郵件中，請搭配使用 getId()。

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

參數

名稱	類型	說明
id	String	要擷取的訊息 ID

回攻員

GmailMessage：具有指定 ID 的訊息

擲回

Error：如果找不到 ID 為指定值的郵件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• getThreadById(id)

---

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()}`);
}

參數

名稱	類型	說明
thread	GmailThread	要擷取的訊息會話串

回攻員

GmailMessage[]：與此會話串相對應的訊息陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• getMessagesForThreads(threads)

---

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()}`);
  }
}

參數

名稱	類型	說明
threads	GmailThread[]	要擷取的訊息會話串

回攻員

GmailMessage[][]：訊息陣列的陣列，其中外部陣列中的每個項目對應至一個執行緒，而內部陣列則包含該執行緒中的訊息

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

無論標籤為何，皆會擷取所有「優先處理」收件匣會話串。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並指定要在每次呼叫中擷取的執行緒範圍。

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

回攻員

GmailThread[]：優先收件匣中的 Gmail 主題陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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}`,
);

參數

名稱	類型	說明
start	Integer	要擷取的第一個執行緒的索引
max	Integer	要擷取的執行緒數量上限

回攻員

GmailThread[]：優先收件匣中的 Gmail 主題陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getPriorityInboxUnreadCount()

取得「優先收件匣」中的未讀會話串數量。

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

回攻員

Integer：優先收件匣中含有未讀訊息的會話串數

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getSpamThreads()

無論標籤為何，皆會擷取所有垃圾內容主題串。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並指定要在每次呼叫中擷取的執行緒範圍。

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

回攻員

GmailThread[]：垃圾郵件資料夾中的 Gmail 主題討論串陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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}`);

參數

名稱	類型	說明
start	Integer	要擷取的第一個執行緒的索引
max	Integer	要擷取的執行緒數量上限

回攻員

GmailThread[]：垃圾郵件資料夾中的 Gmail 主題討論串陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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：含有未讀訊息的垃圾郵件會話串數量

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getStarredThreads()

無論標籤為何，皆擷取所有已加星號的會話串。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並指定要在每次呼叫中擷取的執行緒範圍。

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

回攻員

GmailThread[]：已加星號的 Gmail 會話串陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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}`);

參數

名稱	類型	說明
start	Integer	要擷取的第一個執行緒的索引
max	Integer	要擷取的執行緒數量上限

回攻員

GmailThread[]：已加星號的 Gmail 會話串陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getStarredUnreadCount()

取得已加星號的未讀會話串數量。

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

回攻員

Integer：有未讀訊息的已加星對話串數量

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getThreadById(id)

依據 ID 取得會話串。

在 Gmail 執行緒上，請搭配使用 getId() 和此方法。

// 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(),
);

參數

名稱	類型	說明
id	String	要擷取的執行緒 ID。

回攻員

GmailThread：具有指定 ID 的執行緒，如果找不到，則傳回 null。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• getMessageById(id)

---

getTrashThreads()

無論標籤為何，皆可擷取所有垃圾串流。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並指定要在每次呼叫中擷取的執行緒範圍。

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

回攻員

GmailThread[]：垃圾桶中 Gmail 會話串的陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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}`,
);

參數

名稱	類型	說明
start	Integer	要擷取的第一個執行緒的索引
max	Integer	要擷取的執行緒數量上限

回攻員

GmailThread[]：垃圾桶中 Gmail 會話串的陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getUserLabelByName(name)

根據標籤名稱擷取標籤。

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

參數

名稱	類型	說明
name	String	要擷取的標籤名稱

回攻員

GmailLabel：具有指定名稱的 Gmail 標籤

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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[] - 使用者建立的標籤陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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);

參數

名稱	類型	說明
message	GmailMessage	要標示為已讀的訊息

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markMessageUnread(message)

---

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

參數

名稱	類型	說明
message	GmailMessage	要標示為未讀的郵件

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markMessageRead(message)

---

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

參數

名稱	類型	說明
messages	GmailMessage[]	要標示為已讀的郵件陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markMessagesUnread(messages)

---

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

參數

名稱	類型	說明
messages	GmailMessage[]	要標示為未讀取的訊息陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markMessagesRead(messages)

---

markThreadImportant(thread)

將此執行緒標示為重要，並強制執行緒重新整理。

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

參數

名稱	類型	說明
thread	GmailThread	要標示為重要事項的討論串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadUnimportant(thread)

---

markThreadRead(thread)

將此執行緒標示為已讀，並強制執行緒重新整理。

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

參數

名稱	類型	說明
thread	GmailThread	要標示為已讀的討論串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

將此執行緒標示為不重要，並強制執行緒重新整理。

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

參數

名稱	類型	說明
thread	GmailThread	要標示為不重要的執行緒

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadImportant(thread)

---

markThreadUnread(thread)

將這個執行緒標示為未讀，並強制重新整理執行緒。

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

參數

名稱	類型	說明
thread	GmailThread	要標示為未讀取的討論串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadRead(thread)

---

markThreadsImportant(threads)

將這些執行緒標示為重要，並強制執行緒重新整理。

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

參數

名稱	類型	說明
threads	GmailThread[]	要標示為重要項目的執行緒陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

將這些執行緒標示為已讀，並強制執行緒重新整理。

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

參數

名稱	類型	說明
threads	GmailThread[]	要標示為已讀的執行緒陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

將這些執行緒標示為不重要，並強制執行緒重新整理。

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

參數

名稱	類型	說明
threads	GmailThread[]	要標示為不重要的執行緒陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

將這些執行緒標示為未讀，並強制重新整理執行緒。

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

參數

名稱	類型	說明
threads	GmailThread[]	要標示為未讀的討論串陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• markThreadsRead(threads)

---

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

參數

名稱	類型	說明
message	GmailMessage	要移至垃圾桶的郵件

回攻員

GmailApp - Gmail 服務 (用於鏈結)

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveMessagesToTrash(messages)

---

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

參數

名稱	類型	說明
messages	GmailMessage[]	要刪除的郵件

回攻員

GmailApp - Gmail 服務 (用於鏈結)

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

將這個執行緒移至封存資料夾，並強制執行緒重新整理。

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

參數

名稱	類型	說明
thread	GmailThread	要封存的討論串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

moveThreadToInbox(thread)

將這個執行緒移至收件匣，並強制重新整理執行緒。

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

參數

名稱	類型	說明
thread	GmailThread	要移至收件匣的會話串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

將這個執行緒移至垃圾內容，並強制執行緒重新整理。

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

參數

名稱	類型	說明
thread	GmailThread	要移至垃圾內容的討論串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

將這個執行緒移至垃圾桶，並強制重新整理執行緒。

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

參數

名稱	類型	說明
thread	GmailThread	要刪除的會話串

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

將這些執行緒移至封存資料夾，並強制執行緒重新整理。

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

參數

名稱	類型	說明
threads	GmailThread[]	要封存的討論串陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

moveThreadsToInbox(threads)

將這些會話移至收件匣，並強制更新會話。

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

參數

名稱	類型	說明
threads	GmailThread[]	要移至收件匣的執行緒陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

將這些執行緒移至垃圾內容，並強制執行緒重新整理。

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

參數

名稱	類型	說明
threads	GmailThread[]	要移至垃圾內容的執行緒陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToTrash(threads)

將這些執行緒移至垃圾桶，並強制執行緒重新整理。

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

參數

名稱	類型	說明
threads	GmailThread[]	要丟棄的執行緒陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

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...

參數

名稱	類型	說明
message	GmailMessage	要重新整理的訊息

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• refreshMessages(messages)

---

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...

參數

名稱	類型	說明
messages	GmailMessage[]	要重新整理的訊息

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• refreshMessage(message)

---

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 ...

參數

名稱	類型	說明
thread	GmailThread	要重新整理的執行緒

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• refreshThreads(threads)

---

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 ...

參數

名稱	類型	說明
threads	GmailThread[]	要重新整理的執行緒

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• refreshThread(thread)

---

search(query)

使用指定查詢來搜尋 Gmail。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並指定要在每次呼叫中擷取的執行緒範圍。

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

參數

名稱	類型	說明
query	String	搜尋查詢，就像在 Gmail 中輸入的內容

回攻員

GmailThread[]：符合此查詢的 Gmail 討論串陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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);

參數

名稱	類型	說明
query	String	搜尋查詢，就像在 Gmail 中輸入的內容
start	Integer	起始執行緒的索引
max	Integer	要傳回的執行緒數量上限

回攻員

GmailThread[]：符合此查詢的 Gmail 討論串陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

參數

名稱	類型	說明
recipient	String	以半形逗號分隔的電子郵件地址清單
subject	String	電子郵件主旨 (最多 250 個半形字元)
body	String	電子郵件內文

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• sendEmail(recipient, subject, body, options)

---

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(
    '[e-mail]',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

參數

名稱	類型	說明
recipient	String	收件者的地址
subject	String	主旨行 (最多 250 個半形字元)
body	String	電子郵件內文
options	Object	指定進階參數的 JavaScript 物件，如下所列：

進階參數

名稱	類型	說明
attachments	BlobSource[]	要隨電子郵件傳送的檔案陣列
bcc	String	以半形逗號分隔的電子郵件地址清單 (用於副本收件人)
cc	String	以半形逗號分隔的電子郵件地址清單 (用於副本收件者)
from	String	電子郵件應傳送自的地址，必須是 getAliases() 傳回的其中一個值
htmlBody	String	如果已設定，則可轉換為可轉換 HTML 的裝置，而非使用必要的 body 引數；如果您為電子郵件內嵌圖片，則可在 HTML 主體中新增選用的 inlineImages 欄位
inlineImages	Object	JavaScript 物件，其中包含圖片鍵 (String) 與圖片資料 (BlobSource) 的對應關係；這項操作假設您會使用 htmlBody 參數，並以 <img src="cid:imageKey" /> 格式包含這些圖片的參照
name	String	電子郵件寄件者的名稱 (預設為使用者名稱)
noReply	Boolean	true 如果電子郵件應從一般不回覆電子郵件地址傳送，以免收件者回覆電子郵件；這個選項僅適用於 Google Workspace 帳戶，不適用於 Gmail 使用者
replyTo	String	做為預設回覆地址的電子郵件地址 (預設值：使用者的電子郵件地址)

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

設定目前的訊息存取權權杖，讓指令碼能夠存取目前的 GmailMessage 屬性。

只有使用 Gmail 目前郵件範圍的 Google Workspace 外掛程式專案需要使用這個方法。

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

參數

名稱	類型	說明
accessToken	String	從 Gmail 外掛程式動作事件物件取得的臨時存取權權杖。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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);

參數

名稱	類型	說明
message	GmailMessage	要加星號的訊息

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• starMessages(messages)

---

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

參數

名稱	類型	說明
messages	GmailMessage[]	要加星號的訊息陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• starMessage(message)

---

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

參數

名稱	類型	說明
message	GmailMessage	要取消星號的訊息

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• unstarMessages(messages)

---

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

參數

名稱	類型	說明
messages	GmailMessage[]	要取消星號的訊息陣列

回攻員

GmailApp：Gmail 服務，可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• unstarMessage(message)

已淘汰的方法

getChatThreads()

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

取得所有傳統版 Google Hangouts 會話串流和 Google Chat 會話串流，直到 Google 在今年稍晚將所有傳統版 Hangouts 使用者轉換至 Chat 為止。詳情請參閱「瞭解從傳統版 Hangouts 改用 Google Chat 的相關資訊」。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用「paged」呼叫，並在每次呼叫中指定要擷取的執行緒範圍。

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

回攻員

GmailThread[]：Gmail 中的即時通訊串陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getChatThreads(start, max)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

取得一系列傳統版 Google Hangouts 會話串流和 Google Chat 會話串流，直到 Google 在今年稍晚將所有傳統版 Hangouts 使用者轉換至 Chat 為止。詳情請參閱「瞭解從傳統版 Hangouts 改用 Google Chat 的相關資訊」。

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

參數

名稱	類型	說明
start	Integer	要擷取的第一個執行緒的索引
max	Integer	要擷取的執行緒數量上限

回攻員

GmailThread[]：Gmail 即時通訊串的陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/