此页面由 Cloud Translation API 翻译。

Gmail Service

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

类

名称	简介
`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`	使用 replyTo 地址回复此会话中最后一封邮件的发件人。
`reply(body, options)`	`GmailThread`	使用 replyTo 地址（可选参数）回复此会话中最后一封邮件的发件人。
`replyAll(body)`	`GmailThread`	回复发件人（使用 replyTo 地址）以及此会话中最后一封邮件的所有收件人。
`replyAll(body, options)`	`GmailThread`	回复发件人（使用 `replyTo` 地址）以及此会话中最后一封邮件的所有收件人，并附带可选参数。