Skip to content

docs: document mail sender list APIs#1628

Open
infeng wants to merge 1 commit into
larksuite:mainfrom
infeng:feat/7f6f15e
Open

docs: document mail sender list APIs#1628
infeng wants to merge 1 commit into
larksuite:mainfrom
infeng:feat/7f6f15e

Conversation

@infeng

@infeng infeng commented Jun 27, 2026

Copy link
Copy Markdown
Collaborator

Adds documentation for Lark Mail user allow/block sender list APIs and the related generated CLI metadata.

  • Adds domain guidance for mail sender list operations.
  • Expands the lark-mail skill documentation with user allow/block workflows.
  • Adds a reference page for the user allow/block sender list APIs.

Summary by CodeRabbit

  • Documentation
    • Expanded mail usage guidance with clearer workflows for sending, replying, forwarding, drafts, and delivery checks.
    • Added detailed instructions for trusted and blocked sender lists, including search, batch add/remove, scope requirements, and limits.
    • Improved template, alias/public inbox, recall, sharing, and calendar-invite guidance.
    • Updated permissions and API reference details for easier setup and verification.

@coderabbitai

coderabbitai Bot commented Jun 27, 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: 7d2bcbfc-5525-41e1-88b3-0ca0c4aa87a4

📥 Commits

Reviewing files that changed from the base of the PR and between 4c31323 and 15f119e.

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

📝 Walkthrough

Walkthrough

The mail skill and domain docs were expanded with sender allow/block list guidance, broader send and read workflow instructions, updated compose/template/HTML lint rules, and a more explicit API resource and permission reference.

Changes

Lark Mail documentation updates

Layer / File(s) Summary
Overview and workflow framing
skills/lark-mail/SKILL.md
Top-level skill description, shared read requirement, core concepts, workflow steps, and first-run guidance are rewritten.
Recipient search and send routing
skills/lark-mail/SKILL.md
Recipient lookup, send confirmation, scheduled-send timing, and public mailbox or alias selection guidance are expanded.
Allow/block sender list management
skill-template/domains/mail.md, skills/lark-mail/SKILL.md, skills/lark-mail/references/lark-mail-user-allow-block.md
The allow/block sender concept and management steps are added with scoping, list/search, batch add/remove, and scope or limit rules.
Post-send status and sharing
skills/lark-mail/SKILL.md
Send status checks, scheduled-send handling, recall polling, IM sharing, calendar invite mail, and HTML/plain-text read guidance are updated.
Compose, lint, and template shortcuts
skills/lark-mail/SKILL.md
Writing rules, raw EML restrictions, HTML lint behavior, template merge rules, shortcut descriptions, and +lint-html documentation are expanded.
API resources and scope matrix
skills/lark-mail/SKILL.md
The API resource catalog and permission table are rewritten with explicit methods and scope mappings.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • larksuite/cli#749: Also updates mail documentation around confirmation and compliance before write/send actions.
  • larksuite/cli#1527: Also expands SKILL.md guidance around raw API discovery and schema inspection for mail commands.

Suggested labels

documentation

Suggested reviewers

  • chanthuang

Poem

🐇 I hop through mail and moonlit text,
with sender lists all neatly checked.
Templates bloom, the lint bells chime,
and carrots mark a well-kept rhyme.
Thump! The mailbox sings on time.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description mentions the main changes, but it omits the required Summary, Changes, Test Plan, and Related Issues sections. Rewrite it using the repository template and add each required section, including a brief summary, change list, test plan, and related issues.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: documentation for mail sender list APIs.
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 added domain/mail PR touches the mail domain size/L Large or sensitive change across domains or core paths labels Jun 27, 2026
@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@15f119e6d8c59e2c6e7556de7dba74b3a25cf574

🧩 Skill update

npx skills add infeng/cli#feat/7f6f15e -y -g

@github-actions

Copy link
Copy Markdown

PR Quality Summary

CI did not complete successfully. Use the failed check links below to decide whether this PR needs a code change or a rerun.

Failed checks

  • deterministic-gate — failure — details
  • results — failure — details

deterministic-gate

  • skill_command_referenceskills/lark-mail/SKILL.md:235 — example references unknown command "mail user_mailbox.allow_sender list" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/SKILL.md:238 — example references unknown command "mail user_mailbox.blocked_sender list" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/SKILL.md:245 — example references unknown command "mail user_mailbox.blocked_sender batch_create" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/SKILL.md:253 — example references unknown command "mail user_mailbox.allow_sender batch_remove" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/references/lark-mail-user-allow-block.md:21 — example references unknown command "mail user_mailbox.allow_sender list" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/references/lark-mail-user-allow-block.md:24 — example references unknown command "mail user_mailbox.blocked_sender list" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/references/lark-mail-user-allow-block.md:31 — example references unknown command "mail user_mailbox.blocked_sender batch_create" — Action: update the example to use a command present in the command manifest
  • skill_command_referenceskills/lark-mail/references/lark-mail-user-allow-block.md:39 — example references unknown command "mail user_mailbox.allow_sender batch_remove" — Action: update the example to use a command present in the command manifest
  • public_content_jwt_like_tokenskills/lark-mail/SKILL.md:700 — public contribution contains a JWT-like token — Action: remove the value from the public contribution and replace it with a non-sensitive placeholder
  • public_content_jwt_like_tokenskills/lark-mail/SKILL.md:701 — public contribution contains a JWT-like token — Action: remove the value from the public contribution and replace it with a non-sensitive placeholder
  • public_content_jwt_like_tokenskills/lark-mail/SKILL.md:703 — public contribution contains a JWT-like token — Action: remove the value from the public contribution and replace it with a non-sensitive placeholder
  • public_content_jwt_like_tokenskills/lark-mail/SKILL.md:704 — public contribution contains a JWT-like token — Action: remove the value from the public contribution and replace it with a non-sensitive placeholder
  • public_content_jwt_like_tokenskills/lark-mail/SKILL.md:744 — public contribution contains a JWT-like token — Action: remove the value from the public contribution and replace it with a non-sensitive placeholder

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