此页面由 Cloud Translation API 翻译。

Gmail Service

借助此服务，您可以发送电子邮件、撰写草稿、管理标签、标记邮件和会话，以及执行各种其他 Gmail 帐号管理任务。另请参阅 Mail Service，这是一项较简单的服务，仅允许发送电子邮件。

类

名称	简介
`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 文件（Google 表格、Google 文档等）。
`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`	回复此会话上最后一条消息的发件人（使用 ReplyTo 地址）以及所有收件人。
`replyAll(body, options)`	`GmailThread`	使用可选参数回复此会话上最后一条消息的发件人（使用 `replyTo` 地址）和所有收件人。