Skip to content

Email Security: document customer sample submission - #465

Merged
maximelb merged 7 commits into
masterfrom
fbE/sample-submission
Oct 2, 2026
Merged

maximelb merged 7 commits into
masterfrom
fbE/sample-submission

Conversation

@maximelb

@maximelb maximelb commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

What

Documents Email Security customer sample submission: an opt-in way for analysts to copy one message at a time to LimaCharlie so detection can improve.

  • New page docs/email-security/sample-submission.md: why it exists, how to opt in (mailsec_policy record of type sample_sharing), who can submit (mailsec.act; D&R rules, automations and the AI agent cannot), the three categories, what is kept, where, for how long (400 days), restricted, recorded access and customer-visible access counts and timestamps, how to withdraw, what happens when the organization is deleted, the routes, the CLI commands, the refusal messages and a short FAQ.
  • policy.md: the sample_sharing record type, its composition, and sample submissions in the list of what a tenant purge removes.
  • api-reference.md: the submission routes and the two new message actions.
  • cli.md: the new commands and a note on what they do. messages.md and index.md: one-line pointers. mkdocs.yml: nav entry.

Notes for review

  • The CLI commands documented here are added by the open CLI/SDK change in python-limacharlie#411 and need an API release that serves the new routes. Merge this after that release, or expect the commands to be missing from the latest stable CLI until then.
  • I did not add a console walkthrough: the console UI lands separately, so the page only states that withdrawal is possible from the console and documents the record, CLI and API.
  • Nothing in the page goes beyond what the feature does: no claims about interaction with alert-only mode or with the organization's retention settings.

Risk

Docs only.

Tests

mkdocs build --strict passes; list-numbering check, release feed check and pytest tests pass; markdownlint-cli2 reports 0 issues on the touched files.

🤖 Generated with Claude Code

@maximelb

Copy link
Copy Markdown
Contributor Author

/lc-review

lcbill
lcbill previously approved these changes Sep 30, 2026
@maximelb

Copy link
Copy Markdown
Contributor Author

/lc-review

lcbill
lcbill previously approved these changes Sep 30, 2026
@maximelb

Copy link
Copy Markdown
Contributor Author

/lc-review

lcbill
lcbill previously approved these changes Sep 30, 2026
@maximelb

maximelb commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

/lc-review

lcbill
lcbill previously approved these changes Oct 1, 2026
@maximelb

maximelb commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

/lc-review

lcbill
lcbill previously approved these changes Oct 1, 2026
lcbill
lcbill previously approved these changes Oct 1, 2026
@maximelb

maximelb commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

/lc-review

lcbill
lcbill previously approved these changes Oct 1, 2026
maximelb and others added 7 commits October 2, 2026 00:14
New Sample Submission page (opt-in, what is kept, where, for how long, who can
open it, withdrawal, routes, CLI, FAQ), plus the sample_submission policy
record, API routes, CLI commands and index/nav entries.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…e not errors

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
… retention and purge details

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@limacharlie-refractionpoint

Copy link
Copy Markdown

LimaCharlie Cloud Security — code scan

No new code findings were introduced by this pull request.

This check reports and never fails: no gating.fail_on is set on the code_scanning policy.

Scanned refractionPOINT/documentation ace2ea0…13194c9 — only findings new in the head commit are listed; anything already on the base branch is the repository's own finding set, on the Cloud Security Code page.

This comment is updated in place on every push to this pull request.

@maximelb
maximelb merged commit ca11593 into master Oct 2, 2026
8 checks passed
@maximelb
maximelb deleted the fbE/sample-submission branch October 2, 2026 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants