Skip to content

docs: document mail sender list commands#1732

Open
infeng wants to merge 3 commits into
larksuite:mainfrom
infeng:feat/15d4aa1
Open

docs: document mail sender list commands#1732
infeng wants to merge 3 commits into
larksuite:mainfrom
infeng:feat/15d4aa1

Conversation

@infeng

@infeng infeng commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Updates the Mail command documentation for user mailbox sender lists.

  • Documents allowed_senders and blocked_senders list, batch_set, and batch_delete commands.
  • Adds command examples, arguments, scopes, and output notes for the sender list workflows.
  • Adds a focused reference page for user mailbox sender management.

Summary by CodeRabbit

  • Documentation
    • Added new guidance for user-level sender allowlists/blacklists in mail, including the correct CLI resources and methods (list, batch_create, batch_remove), plus explicit confirmation requirements (no batch_set/batch_delete).
    • Expanded the mail skill guide with safer sending flows (recipient/content confirmation), stricter scheduled-send confirmation pairing, and post-send delivery status verification.
    • Refreshed command usage and expanded HTML/plain-text, recall, templates, and shortcut/draft sending documentation.
    • Introduced a new dedicated reference page for user sender allowlist/blacklist usage.

@github-actions github-actions Bot added domain/mail PR touches the mail domain size/L Large or sensitive change across domains or core paths labels Jul 3, 2026
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d0ecadd3-60e4-4ea2-af00-55659e9abef2

📥 Commits

Reviewing files that changed from the base of the PR and between b5d870b and 1fdc078.

📒 Files selected for processing (2)
  • skills/lark-mail/SKILL.md
  • skills/lark-mail/references/lark-mail-user-senders.md
✅ Files skipped from review due to trivial changes (1)
  • skills/lark-mail/references/lark-mail-user-senders.md

📝 Walkthrough

Walkthrough

This PR adds documentation for user-level sender allowlists/blacklists, expands the lark-mail skill guide with sending, HTML, template, and API resource guidance, and introduces a new reference doc for sender allow/blocked list CLI usage.

Changes

Sender allowlist/blacklist and mail skill documentation

Layer / File(s) Summary
Domain template baseline updates
skill-template/domains/mail.md
Adds core-concept, confirmation, and dedicated sender allow/blocked list documentation for allow_senders and blocked_senders.
Standalone user-senders reference doc
skills/lark-mail/references/lark-mail-user-senders.md
New reference covering CLI resources, methods, scopes, examples, and parameters for sender allow/deny lists.
SKILL.md front-matter and core concepts
skills/lark-mail/SKILL.md
Updates the mail skill description, shared-doc requirement, and core concepts for rules, templates, and sender allow/deny terminology.
Workflow, recipient search, and command-usage rules
skills/lark-mail/SKILL.md
Revises workflow guidance, adds the first-use -h rule, and expands recipient lookup through multi_entity search.
Sending safety, mailboxes/aliases, delivery, recall, sharing, calendar
skills/lark-mail/SKILL.md
Adds send confirmation, delivery verification, mailbox/send-as, recall, sharing, and calendar-invite constraints.
HTML formatting, lint behavior, and templates
skills/lark-mail/SKILL.md
Documents HTML style rules, raw EML prohibition, lint behavior, read-time HTML control, and template merge/attachment rules.
Shortcuts and API resource/permission tables
skills/lark-mail/SKILL.md
Adds +lint-html and +draft-send guidance plus expanded API resource and permission mappings.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

  • larksuite/cli#749: Adds the same explicit confirmation pattern for batch write operations in mail documentation.
  • larksuite/cli#1527: Also updates skills/lark-mail/SKILL.md with mail API/resource and confirmation guidance.
  • larksuite/cli#534: Overlaps on mail send flow guidance, including scheduled send confirmation and post-send status checks.

Suggested labels: size/M

Suggested reviewers: chanthuang

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing the required Summary, Changes, Test Plan, and Related Issues sections from the template. Rewrite it to match the template, adding a brief summary, a changes list, a test plan, and related issue references.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the PR's main documentation change for mail sender list commands.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@1fdc0782b9bf72d198cc19393d1f698dda257993

🧩 Skill update

npx skills add infeng/cli#feat/15d4aa1 -y -g

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/lark-mail/SKILL.md`:
- Line 4: The front-matter description in SKILL.md is missing sender-management
triggers, so prompts about allow/deny sender workflows may not route to this
skill. Update the existing description text near the top of the file to include
the sender-list keywords already used elsewhere, keeping the current mail
actions coverage intact; use the description field in the skill metadata as the
place to add those sender-management intents.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1b76e2bd-e262-434f-b077-cc54b6c40f3e

📥 Commits

Reviewing files that changed from the base of the PR and between cccf025 and aff2f30.

📒 Files selected for processing (3)
  • skill-template/domains/mail.md
  • skills/lark-mail/SKILL.md
  • skills/lark-mail/references/lark-mail-user-senders.md

Comment thread skills/lark-mail/SKILL.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
skills/lark-mail/SKILL.md (1)

68-69: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Include rules.sort in the confirmation matrix.

Rule is documented as supporting sorting, and reordering rules can change mail-routing precedence. Leaving it out here lets a mutating workflow skip the required preview/confirmation step.

♻️ Proposed fix
-| 修改收信规则 | `rules.create` / `update` / `delete` | ✅ 必须 |
+| 修改收信规则 | `rules.create` / `update` / `delete` / `sort` | ✅ 必须 |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@skills/lark-mail/SKILL.md` around lines 68 - 69, The confirmation matrix is
missing `rules.sort`, so the documented rule-reordering action can bypass the
required preview/confirmation step. Update the matrix in `SKILL.md` to include
`rules.sort` alongside the other rule mutations, keeping the existing `Rule` and
`rules.create`/`update`/`delete` entries consistent with the documented
workflow.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@skills/lark-mail/SKILL.md`:
- Around line 68-69: The confirmation matrix is missing `rules.sort`, so the
documented rule-reordering action can bypass the required preview/confirmation
step. Update the matrix in `SKILL.md` to include `rules.sort` alongside the
other rule mutations, keeping the existing `Rule` and
`rules.create`/`update`/`delete` entries consistent with the documented
workflow.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 51d015d5-aefe-4da0-a28b-69f20b75a2be

📥 Commits

Reviewing files that changed from the base of the PR and between aff2f30 and b5d870b.

📒 Files selected for processing (1)
  • skills/lark-mail/SKILL.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/mail PR touches the mail domain size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant