docs(mail): document user sender lists#1622
Open
infeng wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughDocs add user-level sender allow/block list guidance to the mail skill templates and reference material, including core definitions, confirmation rules, workflow placement, and CLI examples for listing, adding, and removing entries. ChangesUser-level sender list docs
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
github-actions
Bot
added
domain/mail
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
skill-template/domains/mail.md (1)
492-512: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueConsider completing the example matrix for sender list operations.
The three examples cover an asymmetric mix:
allow_senders list,blocked_senders batch_create, andallow_senders batch_remove. For clarity, consider showing a complete cycle for one resource (e.g., also includeallow_senders batch_create) or symmetric pairs (e.g., also showblocked_senders batch_remove). This helps readers infer the pattern without guessing which resource supports which operation.🤖 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 `@skill-template/domains/mail.md` around lines 492 - 512, The sender list examples are incomplete and asymmetrical, which makes the operation pattern hard to infer. Update the examples under user_mailbox.allow_senders / user_mailbox.blocked_senders to show a complete or symmetric set of CRUD-style operations, such as adding the missing allow_senders batch_create example or adding a blocked_senders batch_remove example. Keep the existing user_mailbox.* symbols and align the examples so readers can see matching list/create/remove usage for each resource.skills/lark-mail/references/lark-mail-user-sender-lists.md (1)
29-62: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winClarify the request shape asymmetry between
batch_createandbatch_remove.
batch_createuses--data '{"items":[{"sender":"...","sender_type":1}]}'whilebatch_removeuses--data '{"senders":["..."]}'. This is a significant shape difference (objects withsender_typevs plain strings). Consider adding a brief inline note explaining thatbatch_removeonly requires the sender/ domain identifier because the list type is already implicit in the resource path, whereasbatch_createmust disambiguate email vs domain viasender_type.This reduces user confusion and support burden.
🤖 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/references/lark-mail-user-sender-lists.md` around lines 29 - 62, Clarify the payload shape difference in the Lark Mail sender list examples by adding a brief note near the `batch_create` and `batch_remove` sections in `lark-mail-user-sender-lists.md`: `batch_create` on `user_mailbox.allow_senders` and `user_mailbox.blocked_senders` needs `items` objects with `sender_type` to distinguish email vs domain, while `batch_remove` only needs a `senders` array of identifiers because the resource already implies the list type. Keep the examples unchanged, but add the explanation where readers can see both `batch_create` and `batch_remove` usage together.
🤖 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.
Nitpick comments:
In `@skill-template/domains/mail.md`:
- Around line 492-512: The sender list examples are incomplete and asymmetrical,
which makes the operation pattern hard to infer. Update the examples under
user_mailbox.allow_senders / user_mailbox.blocked_senders to show a complete or
symmetric set of CRUD-style operations, such as adding the missing allow_senders
batch_create example or adding a blocked_senders batch_remove example. Keep the
existing user_mailbox.* symbols and align the examples so readers can see
matching list/create/remove usage for each resource.
In `@skills/lark-mail/references/lark-mail-user-sender-lists.md`:
- Around line 29-62: Clarify the payload shape difference in the Lark Mail
sender list examples by adding a brief note near the `batch_create` and
`batch_remove` sections in `lark-mail-user-sender-lists.md`: `batch_create` on
`user_mailbox.allow_senders` and `user_mailbox.blocked_senders` needs `items`
objects with `sender_type` to distinguish email vs domain, while `batch_remove`
only needs a `senders` array of identifiers because the resource already implies
the list type. Keep the examples unchanged, but add the explanation where
readers can see both `batch_create` and `batch_remove` usage together.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b82878eb-f6ee-4a59-b562-60b2c0fa54ce
📒 Files selected for processing (3)
skill-template/domains/mail.mdskills/lark-mail/SKILL.mdskills/lark-mail/references/lark-mail-user-sender-lists.md
PR Quality SummaryCI did not complete successfully. Use the failed check links below to decide whether this PR needs a code change or a rerun. Failed checksdeterministic-gate
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@c4067ab16ef28ac52069b10b771c54b32df7c11f🧩 Skill updatenpx skills add infeng/cli#feat/778f950 -y -g |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds mail CLI documentation for managing a user's sender allow and block lists.
Summary by CodeRabbit