本頁面由 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`	刪除這個標籤。
`getId()`	`String`	取得這個標籤的 ID。
`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`	Creates a draft message replying to the sender using the reply-to address and all recipients of this message.
`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`	回覆寄件者 (使用 replyTo 位址)，以及這個討論串中最後一封郵件的所有收件者。
`replyAll(body, options)`	`GmailThread`	回覆寄件者 (使用 `replyTo` 地址) 和這個討論串中最後一封郵件的所有收件者，並提供選用引數。

Gmail Service 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

類別

GmailApp

方法

GmailAttachment

方法

GmailDraft

方法

GmailLabel

方法

GmailMessage

方法

GmailThread

方法

Gmail Service

`GmailApp`

`GmailAttachment`

`GmailDraft`

`GmailLabel`

`GmailMessage`

`GmailThread`