本頁面由 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`	取得這個 blob 的資料，做為採用 UTF-8 編碼的字串。
`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`	如果這個討論串位於優先收件匣，則傳回 true，否則傳回 false。
`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`	回覆寄件者 (使用回覆地址)，以及這個執行緒上最後一則訊息的所有收件者。
`replyAll(body, options)`	`GmailThread`	使用 `replyTo` 地址回覆寄件者，以及這個執行緒中最後一則訊息的所有收件者，並提供選用引數。