ListLabels¶
列出用户的 Gmail 标签。返回系统标签(INBOX、SENT、DRAFTS、UNREAD、STARRED、TRASH、SPAM、IMPORTANT、CATEGORY_PERSONAL、CATEGORY_SOCIAL、CATEGORY_PROMOTIONS、CATEGORY_UPDATES、CATEGORY_FORUMS 等)以及任何用户自定义标签。每个标签都有一个 UUID id 和一个 name。
Gmail 几乎将每个收件箱操作都表示为标签的添加/移除,因此此工具几乎是任何线程管理操作的第一步:先调用一次 ListLabels,通过 name 找到标签的 id,然后将该 id 传给 UpdateThreadLabels。常见配对(在此处查找命名系统标签,然后使用该 id 调用 UpdateThreadLabels):
- 归档线程 → 移除
INBOX(add=false) - 移回收件箱 → 添加
INBOX(add=true) - 标记为已读 → 移除
UNREAD(add=false) - 标记为未读 → 添加
UNREAD(add=true) - 加星标 → 添加
STARRED;取消星标 → 移除STARRED - 移至回收站 → 添加
TRASH;从回收站恢复 → 移除TRASH - 标记为重要 → 添加
IMPORTANT;标记为不重要 → 移除IMPORTANT - 举报为垃圾邮件 → 添加
SPAM;标记为非垃圾邮件 → 移除SPAM - 应用或移除自定义用户标签 → 按显示名称查找该标签,然后添加/移除它
在搜索响应时,不区分大小写地匹配标签名称。你也可以使用此工具来了解用户的邮件是如何组织的,然后再按标签进行过滤或搜索。
标签是按收件箱区分的:每个收件箱都有自己的标签 id,因此一个收件箱的标签 id 在另一个收件箱的线程上不起作用。当对特定线程执行操作时,传入其 thread_id,此工具将返回拥有该线程的收件箱的标签(即要传给 UpdateThreadLabels 的匹配 id)。否则,在多收件箱设置中,传入 inbox(来自 ListInboxes 的收件箱电子邮件地址)以列出特定收件箱的标签;两者都省略则使用主要收件箱。
参数¶
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
thread_id |
string | 否 | 列出拥有此线程的收件箱的标签。当你打算在特定线程上添加或移除标签时,使用此参数,以确保标签 id 与该线程的收件箱匹配。优先级高于 inbox。 |
inbox |
string | 否 | 通过电子邮件地址(来自 ListInboxes)限制到特定收件箱。省略则使用主要收件箱。当设置了 thread_id 时忽略此参数。 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 macro3/macro