Skip to content

Momentum#1494 document msys.validate.opendkim.get_sig_result / get_stat_result - #866

Merged
dkoerichbird merged 5 commits into
mainfrom
Momentum#1494_opendkim_verdict_helpers
Aug 12, 2026
Merged

Momentum#1494 document msys.validate.opendkim.get_sig_result / get_stat_result#866
dkoerichbird merged 5 commits into
mainfrom
Momentum#1494_opendkim_verdict_helpers

Conversation

@dkoerichbird

@dkoerichbird dkoerichbird commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Documentation counterpart of SparkPost/Momentum#1495 (issue SparkPost/Momentum#1494).

  • New pages for msys.validate.opendkim.get_sig_result (derive the Authentication-Results verdict for a DKIM signature: pass, or a named fail (...)) and msys.validate.opendkim.get_stat_result (map verification statuses that carry no per-signature verdict to none/permerror/temperror, nil otherwise) — both available starting 5.4.
  • Caution added to the get_sig_errorstr page: for a valid signature it returns the literal string "no signature error", never nil, so it must not be used as a pass/fail test (the misuse behind Momentum#1494).
  • Rows added to the Lua function index and summary table.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes to Momentum Lua reference pages; no runtime or application code.

Overview
Documents two Momentum 5.4 OpenDKIM Lua helpers for building Authentication-Results dkim= clauses: msys.validate.opendkim.get_sig_ar_verdict (per-signature pass or fail (reason)) and msys.validate.opendkim.get_stat_ar_verdict (message-level none / permerror / temperror, or nil when per-signature results apply), including a combined usage example on the new reference page.

get_sig_errorstr is updated to state that valid signatures return "no signature error" (not nil) and that nil-checking must not be used for pass/fail; readers are directed to get_sig_ar_verdict. The Lua function index and summary table gain rows for both new APIs; lastUpdated metadata is refreshed on touched pages.

Reviewed by Cursor Bugbot for commit 3e12105. Bugbot is set up for automated code reviews on this repo. Configure here.

dkoerichbird and others added 3 commits August 11, 2026 10:52
…at_result

New Lua helpers that derive the Authentication-Results verdict for a DKIM
signature (pass, or a named failure) and map verification statuses that
carry no per-signature verdict (none/permerror/temperror). Also caution on
the get_sig_errorstr page: its return for a valid signature is the literal
"no signature error", never nil, so it must not be used as a pass/fail test.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…sed)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Aug 11, 2026

Copy link
Copy Markdown

Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 3e12105
🔍 Latest deploy log https://app.netlify.com/projects/support-docs/deploys/6a7b39b52f869800082546d1
😎 Deploy Preview https://deploy-preview-866--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
Comment thread content/momentum/4/lua/ref-msys-validate-opendkim-get-sig-errorstr.md Outdated
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
@dkoerichbird
dkoerichbird requested a review from juliebin August 11, 2026 15:05
@dkoerichbird
dkoerichbird merged commit 5030685 into main Aug 12, 2026
5 of 6 checks passed
@dkoerichbird
dkoerichbird deleted the Momentum#1494_opendkim_verdict_helpers branch August 12, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants