Skip to content

docs(skills): document mail user_mailbox allow/blocked senders#930

Open
infeng wants to merge 1 commit into
larksuite:mainfrom
infeng:feat/58a3df6
Open

docs(skills): document mail user_mailbox allow/blocked senders#930
infeng wants to merge 1 commit into
larksuite:mainfrom
infeng:feat/58a3df6

Conversation

@infeng
Copy link
Copy Markdown
Collaborator

@infeng infeng commented May 17, 2026

Generated by the harness-coding skill (recovery run — original attempt crashed before MR open).

  • Branch: feat/58a3df6
  • Target: main

The commit below was produced by a prior coding run on this branch. The current resume run regenerated the sprint plan from tech-specs and confirmed it already implements the work. Any sprint with status passed in the table below represents work this resume run added on top.

Commits on branch (ahead of main)

Commit Subject
a91590d docs(skills): document mail user_mailbox allow/blocked senders

This resume run

ID Title Status Commit
S5 Synthesize transport contract for larksuite/cli passed 898e0ee
S8 Update public lark CLI generated mail metadata passed a91590d

This MR was created autonomously. Quality gates were enforced by the repo's own pre-commit hooks.

Summary by CodeRabbit

Documentation

  • Added comprehensive documentation for sender allow/block list management functionality
  • Documented user-level whitelist and blacklist capabilities with support for email addresses and domains
  • Detailed new API endpoints for managing trusted and blocked senders
  • Specified permission scopes and mutual exclusivity rules for allow/block configurations

Review Change Stack

Update the lark-mail skill artifacts to reflect the new public OAPI
resources for user-level mail allow / block sender lists:

- skills/lark-mail/SKILL.md: add description keywords (信任发件人 /
  屏蔽发件人 / allow / block sender), an Allow/Block Sender entity
  blurb, two API Resources sections (user_mailbox.allow_senders and
  user_mailbox.blocked_senders, each with list / batch_create /
  batch_remove), and 6 permission table rows mapping the new methods
  to mail:user_mailbox.message:modify and :readonly scopes.

- skill-template/domains/mail.md: mirror the entity blurb so future
  SKILL.md regenerations keep the description in sync.

internal/registry/meta_data.json is gitignored and fetched from the
published registry by scripts/fetch_meta.py at install time, so it is
intentionally not part of this commit.

sprint: S8
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44122767-e4c2-486e-98b9-74d4b7880c88

📥 Commits

Reviewing files that changed from the base of the PR and between 898e0ee and a91590d.

📒 Files selected for processing (2)
  • skill-template/domains/mail.md
  • skills/lark-mail/SKILL.md

📝 Walkthrough

Walkthrough

This PR adds documentation for user-level email sender allow/block list management. The skill definition and domain template introduce the feature concept, document two new API endpoints (user_mailbox.allow_senders and user_mailbox.blocked_senders), and define required permission scopes for their operations.

Changes

Allow/Block Sender List Documentation

Layer / File(s) Summary
Core Concept and Description
skills/lark-mail/SKILL.md, skill-template/domains/mail.md
Skill description and core concepts section document user-level allow/block sender lists scoped to user_mailbox_id, with mutual exclusivity between allow and block entries, quota limits, reason_code failure handling, and distinction from tenant-level sender resources.
API Endpoint and Operation Documentation
skills/lark-mail/SKILL.md
Two new endpoints user_mailbox.allow_senders and user_mailbox.blocked_senders are documented with supported operations (batch_create, list, batch_remove) and sender_type field supporting address and domain granularity.
Permission Scope Mappings
skills/lark-mail/SKILL.md
Permissions table is extended with scope requirements: list operations require message read scope; batch create and batch remove operations require message modify scope.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • larksuite/cli#594: Both PRs touch the same mail skill documentation files and directly adjust the "黑白名单(Allow / Block Sender)" section in skills/lark-mail/SKILL.md and skill-template/domains/mail.md.

Suggested labels

documentation, domain/mail, size/M

Suggested reviewers

  • chanthuang
  • haidaodashushu

Poem

🐰 A white list and a black list, both here to stay,
User mailboxes sorted in a trustworthy way,
Senders sorted, scopes defined, permissions all clear,
Documentation polished for the mail engineers! 📧✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete, missing key sections from the template including Summary, Changes list, Test Plan, and Related Issues. Add required template sections: Summary (1-3 sentences), Changes (bulleted list), Test Plan with checkboxes, and Related Issues section to match the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: documentation additions for mail user_mailbox allow/blocked sender functionality.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@github-actions github-actions Bot added domain/mail PR touches the mail domain size/M Single-domain feat or fix with limited business impact labels May 17, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.92%. Comparing base (898e0ee) to head (a91590d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #930   +/-   ##
=======================================
  Coverage   65.92%   65.92%           
=======================================
  Files         523      523           
  Lines       49692    49692           
=======================================
  Hits        32758    32758           
  Misses      14134    14134           
  Partials     2800     2800           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add infeng/cli#feat/58a3df6 -y -g

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/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant