本頁面由 Cloud Translation API 翻譯而成。

Gmail Service

這項服務可讓您傳送電子郵件、撰寫草稿、管理標籤、標記郵件和討論串，以及執行各種其他 Gmail 帳戶管理工作。另請參閱郵件服務，這是一項較簡單的服務，只允許傳送電子郵件。

類別

名稱	簡短說明
`GmailApp`	提供 Gmail 會話串、郵件和標籤的存取權。
`GmailAttachment`	Gmail 中的附件。
`GmailDraft`	使用者在 Gmail 帳戶中建立的草稿郵件。
`GmailLabel`	使用者在 Gmail 帳戶中建立的標籤。
`GmailMessage`	使用者 Gmail 帳戶中的郵件。
`GmailThread`	使用者 Gmail 帳戶中的會話串。

`GmailApp`

方法

方法	傳回類型	簡短說明
`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`	移除這些訊息的星號，並強制重新整理訊息。

`GmailAttachment`

方法

方法	傳回類型	簡短說明
`copyBlob()`	`Blob`	傳回此 Blob 的副本。
`getAs(contentType)`	`Blob`	將此物件內的資料傳回為轉換為指定內容類型的 Blob。
`getBytes()`	`Byte[]`	取得儲存在此 Blob 中的資料。
`getContentType()`	`String`	取得此 Blob 中位元組的內容類型。
`getDataAsString()`	`String`	以 UTF-8 編碼的字串格式，取得此 Blob 的資料。
`getDataAsString(charset)`	`String`	以指定的編碼方式，取得此 blob 的資料做為字串。
`getHash()`	`String`	取得此附件的 SHA1 內容雜湊。
`getName()`	`String`	取得 Blob 的名稱。
`getSize()`	`Integer`	取得此附件的大小。
`isGoogleType()`	`Boolean`	傳回這個 Blob 是否為 Google Workspace 檔案 (試算表、文件等)。
`setBytes(data)`	`Blob`	設定儲存在此 Blob 中的資料。
`setContentType(contentType)`	`Blob`	設定此 blob 中位元組的內容類型。
`setContentTypeFromExtension()`	`Blob`	根據檔案副檔名，設定此 Blob 中位元組的內容類型。
`setDataFromString(string)`	`Blob`	從採用 UTF-8 編碼的字串，設定此 blob 的資料。
`setDataFromString(string, charset)`	`Blob`	從使用指定編碼的字串中，設定此 blob 的資料。
`setName(name)`	`Blob`	設定此 Blob 的名稱。

`GmailDraft`

方法

方法	傳回類型	簡短說明
`deleteDraft()`	`void`	刪除這則草稿訊息。
`getId()`	`String`	取得草稿郵件的 ID。
`getMessage()`	`GmailMessage`	傳回代表此草稿的 GmailMessage。
`getMessageId()`	`String`	傳回代表此草稿的 `GmailMessage` ID。
`send()`	`GmailMessage`	傳送此草稿電子郵件。
`update(recipient, subject, body)`	`GmailDraft`	取代草稿訊息的內容。
`update(recipient, subject, body, options)`	`GmailDraft`	使用選用引數，替換草稿訊息的內容。

`GmailLabel`

方法

方法	傳回類型	簡短說明
`addToThread(thread)`	`GmailLabel`	將這個標籤新增至指定的執行緒，並強制執行緒重新整理 (`GmailThread.refresh()`)。
`addToThreads(threads)`	`GmailLabel`	將此標籤新增至指定的執行緒，並強制執行緒重新整理。
`deleteLabel()`	`void`	刪除這個標籤。
`getName()`	`String`	取得此標籤的名稱。
`getThreads()`	`GmailThread[]`	取得標有此標籤的執行緒。
`getThreads(start, max)`	`GmailThread[]`	取得標示為此標籤的執行緒範圍。
`getUnreadCount()`	`Integer`	取得標有此標籤的未讀會話串數量。
`removeFromThread(thread)`	`GmailLabel`	從指定的執行緒中移除此標籤，並強制執行緒重新整理。
`removeFromThreads(threads)`	`GmailLabel`	從指定的執行緒中移除此標籤，並強制執行緒重新整理。

`GmailMessage`

方法

方法	傳回類型	簡短說明
`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`	取得此訊息的 ID。
`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`	移除訊息的星號。

`GmailThread`

方法

方法	傳回類型	簡短說明
`addLabel(label)`	`GmailThread`	將此標籤新增至執行緒。
`createDraftReply(body)`	`GmailDraft`	使用回覆地址，建立草稿訊息，回覆這個會話串中上一則訊息的寄件者。
`createDraftReply(body, options)`	`GmailDraft`	使用回覆地址和選用引數，建立草稿訊息，回覆此執行緒中上次訊息的寄件者。
`createDraftReplyAll(body)`	`GmailDraft`	使用回覆地址和此訊息的所有收件者，建立回覆此討論串中上一個訊息寄件者的草稿訊息。
`createDraftReplyAll(body, options)`	`GmailDraft`	使用回覆地址和所有收件者，以及選用引數，建立回覆此執行緒中最後一則訊息寄件者的草稿訊息。
`getFirstMessageSubject()`	`String`	取得討論串中第一則訊息的主旨。
`getId()`	`String`	取得此執行緒的 ID。
`getLabels()`	`GmailLabel[]`	傳回使用者在這個執行緒上建立的標籤。
`getLastMessageDate()`	`Date`	取得此執行緒最近一則訊息的日期。
`getMessageCount()`	`Integer`	傳回討論串中的訊息數。
`getMessages()`	`GmailMessage[]`	取得這個會話串中的訊息。
`getPermalink()`	`String`	取得這個會話串的永久連結。
`hasStarredMessages()`	`Boolean`	傳回會話串是否含有任何已加星號的訊息。
`isImportant()`	`Boolean`	傳回會話群組是否已標示為重要。
`isInChats()`	`Boolean`	傳回會話串是否標示為聊天。
`isInInbox()`	`Boolean`	傳回討論串是否位於收件匣中。
`isInPriorityInbox()`	`Boolean`	如果這個會話串位於「優先收件匣」中，則傳回「是」；否則傳回「否」。
`isInSpam()`	`Boolean`	傳回討論串是否已標示為垃圾內容。
`isInTrash()`	`Boolean`	傳回討論串是否位於垃圾桶中。
`isUnread()`	`Boolean`	傳回會話串是否有未讀訊息。
`markImportant()`	`GmailThread`	將這個會話串標示為重要。
`markRead()`	`GmailThread`	將這個討論串標示為已讀。
`markUnimportant()`	`GmailThread`	將此執行緒標示為不重要。
`markUnread()`	`GmailThread`	將此會話串標示為未讀。
`moveToArchive()`	`GmailThread`	將這個執行緒移至封存區。
`moveToInbox()`	`GmailThread`	將這個會話串移至收件匣。
`moveToSpam()`	`GmailThread`	將這個會話移至垃圾郵件。
`moveToTrash()`	`GmailThread`	將這個會話移至垃圾桶。
`refresh()`	`GmailThread`	重新載入此執行緒和 Gmail 的相關狀態 (如果標籤、已讀狀態等有所變更，這項操作就很實用)。
`removeLabel(label)`	`GmailThread`	從對話串中移除這個標籤。
`reply(body)`	`GmailThread`	使用 replyTo 地址回覆會話串中最後一則訊息的寄件者。
`reply(body, options)`	`GmailThread`	使用 replyTo 位址回覆會話串中最後一則訊息的寄件者，並提供選用引數。
`replyAll(body)`	`GmailThread`	回覆寄件者 (使用 replyTo 地址) 和這個會話串中最後一封郵件的所有收件者。
`replyAll(body, options)`	`GmailThread`	回覆寄件者 (使用 `replyTo` 位址) 和這個會話串上最後一封郵件的所有收件者，並提供選用引數。