Gmail Service

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

這項服務可讓您傳送電子郵件、撰寫草稿、管理標籤、標示郵件和會話串,以及執行其他各種 Gmail 帳戶管理工作。 另請參閱郵件服務,這項簡易的服務僅允許傳送電子郵件。

類別

名稱簡短說明
GmailApp可讓你存取 Gmail 會話串、郵件和標籤。
GmailAttachmentGmail 中的附件。
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取得這封郵件的收件者副本 (密件副本)。#39;d
getBody()String取得這個訊息內文的 HTML 內容。
getCc()String取得該郵件的半形逗號收件者副本 (#39;d)。
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使用回覆地址回覆這個討論串中最後一則訊息的寄件者。
reply(body, options)GmailThread使用回覆引數 (包括選用引數) 回覆這個執行緒中最後一則訊息的寄件者。
replyAll(body)GmailThread回覆這個寄件者 (使用回覆至地址) 以及這個會話串中最後一則訊息的所有收件者。
replyAll(body, options)GmailThread使用選用引數回覆寄件者 (使用 replyTo 位址),以及這個會話串中最後一則訊息的所有收件者。