Skip to content

docs(skills): regenerate lark-mail SKILL.md for user_mailbox allow/blocked senders #702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
infeng wants to merge 1 commit into
base: main
Choose a base branch
from
+54 −36
Open

docs(skills): regenerate lark-mail SKILL.md for user_mailbox allow/blocked senders #702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 54 additions & 36 deletions skills/lark-mail/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,80 +419,92 @@ lark-cli mail <resource> <method> [flags] # 调用 API

### user_mailboxes

- `accessible_mailboxes` — 列出可访问的邮箱
- `profile` — 获取用户邮箱信息
- `accessible_mailboxes` — 获取主账号的所有可访问邮箱，包括主邮箱和公共邮箱
- `profile` — 用于在用户身份下获取自己的邮箱主地址
- `search` — 搜索邮件

### user_mailbox.allow_senders

- `batch_create` — 批量将发件人加入指定用户邮箱的「信任发件人」白名单。支持按邮箱地址 (sender_type=1) 或域名 (sender_type=2) 添加。单次最多 100 项，单用户黑白名单合计最多 2000 项；与黑名单互斥（添加白名单会从黑名单删除对侧记录）。
- `batch_remove` — 批量从指定用户邮箱的「信任发件人」白名单中删除发件人。senders 中每项可以是邮箱地址或域名（与添加时一致）。批量删除按字面值哈希匹配，可兼容历史大写数据。单次最多 100 项。
- `list` — 列表/搜索指定用户邮箱的「信任发件人」白名单。支持按发件人地址或域名前缀搜索 (keyword)。返回列表按创建时间倒序，使用 page_token + page_size 进行分页。

### user_mailbox.blocked_senders

- `batch_create` — 批量将发件人加入指定用户邮箱的「屏蔽发件人」黑名单。支持按邮箱地址 (sender_type=1) 或域名 (sender_type=2) 添加。单次最多 100 项，单用户黑白名单合计最多 2000 项；与白名单互斥（添加黑名单会从白名单删除对侧记录）。
- `batch_remove` — 批量从指定用户邮箱的「屏蔽发件人」黑名单中删除发件人。senders 中每项可以是邮箱地址或域名（与添加时一致）。批量删除按字面值哈希匹配，可兼容历史大写数据。单次最多 100 项。
- `list` — 列表/搜索指定用户邮箱的「屏蔽发件人」黑名单。支持按发件人地址或域名前缀搜索 (keyword)。返回列表按创建时间倒序，使用 page_token + page_size 进行分页。

### user_mailbox.drafts

- `cancel_scheduled_send` — 取消定时发送
- `create` — 创建草稿
- `delete` — 删除草稿
- `get` — 获取草稿内容
- `list` — 列出草稿列表
- `delete` — 删除指定邮箱账户下的单份邮件草稿。注意：对于草稿状态的邮件，只能使用本接口删除，禁止使用 trash_message；被删除的草稿数据无法恢复，请谨慎使用。
- `get` — 获取草稿详情
- `list` — 拉取草稿列表
- `send` — 发送草稿
- `update` — 更新草稿

### user_mailbox.event

- `subscribe` — 订阅事件
- `subscription` — 获取订阅状态
- `unsubscribe` — 取消订阅
- `subscribe` — 订阅收信事件
- `subscription` — 查询订阅的收信事件
- `unsubscribe` — 取消订阅收信事件

### user_mailbox.folders

- `create` — 创建邮箱文件夹
- `delete` — 删除邮箱文件夹
- `get` — 获取邮箱文件夹信息
- `list` — 列出邮箱文件夹
- `patch` — 修改邮箱文件夹
- `delete` — 删除用户文件夹。删除后文件夹数据无法恢复，请谨慎使用；删除文件夹会将该文件夹下的邮件移至已删除文件夹中。
- `get` — 获取指定邮箱账户下的单个邮件文件夹详情
- `list` — 列出用户文件夹，可获取文件夹名称、文件夹ID、文件夹下的未读邮件和未读会话数量
- `patch` — 更新用户文件夹

### user_mailbox.labels

- `create` — 创建标签
- `delete` — 删除标签
- `get` — 获取标签信息
- `list` — 列出标签
- `patch` — 更新标签
- `create` — 根据用户指定的名称、颜色等信息，创建邮件标签
- `delete` — 删除用户指定的标签，注意，删除的标签无法恢复
- `get` — 根据指定ID，获取邮件标签信息，包括名称、未读数据、颜色等信息
- `list` — 列出邮件标签，包括ID、名称、颜色、未读信息等内容
- `patch` — 更新邮件标签

### user_mailbox.mail_contacts

- `create` — 创建邮箱联系人
- `delete` — 删除邮箱联系人
- `delete` — 删除指定的邮箱联系人
- `list` — 列出邮箱联系人
- `patch` — 修改邮箱联系人信息
- `patch` — 更新邮箱联系人

### user_mailbox.message.attachments

- `download_url` — 获取附件下载链接

### user_mailbox.messages

- `batch_get` — 批量获取邮件详情
- `batch_modify` — 批量修改邮件
- `batch_trash` — 批量删除邮件
- `batch_get` — 通过指定邮件ID，获取对应邮件的标签、文件夹、摘要、正文、html、附件等信息。注意，如需获取摘要、正文、主题或收发件人地址，需要申请对应的字段权限。
- `batch_modify` — 本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件读和未读、移动邮件至垃圾邮件等能力。不支持移动邮件到已删除文件夹，如需，请使用批量删除邮件接口。
- `batch_trash` — 通过指定邮件ID，批量移动邮件到已删除文件夹
- `get` — 获取邮件详情
- `list` — 列出邮件
- `modify` — 修改邮件
- `list` — 根据用户指定的标签或文件夹，列出对应位置下的邮件列表。注意，必须填写folder_id或label_id中的一个字段。
- `modify` — 本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件已读和未读、移动邮件至垃圾邮件等能力。不支持移动邮件到已删除文件夹，如需删除邮件，请使用删除邮件接口。至少填写add_label_ids、remove_label_ids、add_folder中的一个参数。
- `send_status` — 查询邮件发送状态
- `trash` — 删除邮件
- `trash` — 移动邮件到已删除文件夹。注意，该接口无法删除草稿，如需删除草稿，请使用删除草稿接口

### user_mailbox.rules

- `create` — 创建收信规则
- `delete` — 删除收信规则
- `list` — 列出收信规则
- `reorder` — 对收信规则进行排序
- `update` — 更新收信规则
- `reorder` —
- `update` —
Comment on lines +497 to +498
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fill missing method descriptions for rules APIs

Line 497 and Line 498 have empty descriptions for user_mailbox.rules.reorder and user_mailbox.rules.update. This is a docs regression in a high-traffic reference section.

📝 Suggested patch 
-  - `reorder` — 
-  - `update` — 
+  - `reorder` — 调整收信规则执行顺序
+  - `update` — 更新指定收信规则的条件或动作配置
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@skills/lark-mail/SKILL.md` around lines 497 - 498, The docs currently have
empty descriptions for user_mailbox.rules.reorder and user_mailbox.rules.update
in SKILL.md; update the two entries to include concise descriptions: for
user_mailbox.rules.reorder explain it reorders rule evaluation priority by
accepting an ordered list of rule IDs (or positions) and returns the updated
rule sequence, and for user_mailbox.rules.update describe it updates a specific
rule’s properties (conditions, actions, enabled flag, etc.) given a rule ID and
payload and returns the modified rule; place these summaries in the lines for
`reorder` and `update` respectively so the high-traffic reference shows
meaningful explanations.


### user_mailbox.sent_messages

- `get_recall_detail` — 查询邮件撤回进度
- `recall` — 撤回已发送的邮件
- `get_recall_detail` — 查询指定邮件的撤回结果详情，包括整体撤回进度、成功/失败/处理中的收件人数量，以及每个收件人的撤回状态和失败原因。
- `recall` — 撤回指定邮件。前置条件：邮件须已投递，且发送时间在 24 小时以内；搬家中的域名不支持撤回。返回说明：若用户或邮件不满足撤回条件，接口仍返回 200，响应体中 recall_status 为 unavailable，recall_restriction_reason 标明具体原因。返回成功仅表示撤回请求已受理，实际撤回结果请调用「查询邮件撤回进度」接口获取。

### user_mailbox.settings

- `send_as` — 列出可发信邮箱
- `send_as` — 获取账号的所有可发信地址，包括主地址、别名地址、邮件组。可以使用用户地址访问该接口，也可以使用用户有权限的公共邮箱地址访问该接口。

### user_mailbox.template.attachments

Expand All @@ -508,12 +520,12 @@ lark-cli mail <resource> <method> [flags] # 调用 API

### user_mailbox.threads

- `batch_modify` — 批量修改邮件会话
- `batch_trash` — 批量删除邮件会话
- `get` — 获取邮件会话详情
- `list` — 列出邮件会话
- `modify` — 修改邮件会话
- `trash` — 删除邮件会话
- `batch_modify` — 本接口提供修改邮件会话的能力，支持移动邮件会话的文件夹、给邮件会话添加和移除标签、标记邮件会话读和未读、移动邮件会话至垃圾邮件等能力。不支持移动邮件会话到已删除文件夹，如需，请使用批量删除邮件会话接口。
- `batch_trash` — 通过指定邮件会话ID，批量移动邮件到已删除文件夹
- `get` — 通过用户邮箱地址和邮件会话ID，获取该会话下的所有邮件关键信息列表。如需查询主题、正文、摘要、收发件人信息，请申请字段权限。
- `list` — 通过指定文件夹或标签，列出对应位置下的邮件会话列表。接口可返回邮件会话ID和会话下最新一封邮件的摘要。folder_id 和 label_id 必须且只能提供一个。
- `modify` — 本接口提供修改邮件会话的能力，支持移动邮件会话的文件夹、给邮件会话添加和移除标签、标记邮件会话读和未读、移动邮件会话至垃圾邮件等能力。不支持移动邮件会话到已删除文件夹，如需，请使用删除邮件会话接口。至少填写add_label_ids、remove_label_ids、add_folder中的一个参数。
- `trash` — 移动指定的邮件会话到已删除文件夹

## 权限表

Expand All @@ -523,6 +535,12 @@ lark-cli mail <resource> <method> [flags] # 调用 API
| `user_mailboxes.accessible_mailboxes` | `mail:user_mailbox:readonly` |
| `user_mailboxes.profile` | `mail:user_mailbox:readonly` |
| `user_mailboxes.search` | `mail:user_mailbox.message:readonly` |
| `user_mailbox.allow_senders.batch_create` | `mail:user_mailbox.message:modify` |
| `user_mailbox.allow_senders.batch_remove` | `mail:user_mailbox.message:modify` |
| `user_mailbox.allow_senders.list` | `mail:user_mailbox.message:modify` |
| `user_mailbox.blocked_senders.batch_create` | `mail:user_mailbox.message:modify` |
| `user_mailbox.blocked_senders.batch_remove` | `mail:user_mailbox.message:modify` |
| `user_mailbox.blocked_senders.list` | `mail:user_mailbox.message:modify` |
| `user_mailbox.drafts.cancel_scheduled_send` | `mail:user_mailbox.message:send` |
| `user_mailbox.drafts.create` | `mail:user_mailbox.message:modify` |
| `user_mailbox.drafts.delete` | `mail:user_mailbox.message:modify` |
Expand Down
Loading