此页面由 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`	如果此会话位于优先收件箱中，则返回 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` 地址）和此会话中最后一封邮件的所有收件人，并提供可选参数。