docs(outlook-addon): default-off, fail-closed send, Settings view - #77
Merged
Merged
Conversation
Reflects postguard-outlook-addon PRs #63 and #67. Old defaults (opt-out + optimistic displayDialogAsync) are gone; new model: - New "Encryption defaults and per-draft control" section covering pg.encryptionEnabled (mailbox-wide default off), the x-pg-encrypt-on-send header, the persistent compose banner, and the fail-closed/fail-open contract. - New "Settings view" section for the gear icon, pg.encryptionEnabled, pg.allowOptimisticDialog, and the sign-attribute prefills. - Architecture section mentions OnNewMessageCompose alongside OnMessageSend and the new settings.ts helper. - Per-platform behaviour table rewritten around the new prompt-by-default open path and the optimistic opt-in. - displayDialogAsync code excerpt replaced with the new optimistic-vs-prompt logic, pinned to current master HEAD. Closes #76
rubenhensen
approved these changes
May 12, 2026
rubenhensen
pushed a commit
that referenced
this pull request
Jul 10, 2026
* docs: add pg-node example page (from encryption4all/postguard-examples#46) New Node.js example added in postguard-examples. Adds the page, sidebar entry, and overview row. * docs: cover Node 20.3+/Bun/Deno + notify validator (from encryption4all/postguard-js#76, #77) - Add Server-side usage section to postguard-js page - Note upfront YiviSessionError for non-DOM runtimes - Mention validateUploadOptions and the silent-notify console.info * docs: document NetworkException.Url (from encryption4all/postguard-dotnet#31) * docs: document X-POSTGUARD-CLIENT-VERSION header (from encryption4all/postguard-js#90, postguard-dotnet#33) * docs: bump .NET SDK prerequisite to 10.0+ (from encryption4all/postguard-dotnet#35) The postguard-dotnet SDK and the pg-dotnet example both multi-target net8.0;net10.0, so a .NET 10 SDK is required to compile the highest target. Verified against E4A.PostGuard.csproj and the example's PostGuard.Example.csproj. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: document Outlook read dialog for decrypted email (from encryption4all/postguard-outlook-addon#110) Read-mode decryption now shows the plaintext message in a larger popup read dialog (src/read-dialog/, manifest ReadDialog.Url) with the taskpane inline render kept only as a fallback. Updates the architecture section and the read-mode flow note. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: document PKG /statusevents SSE proxy endpoint (from encryption4all/postguard#200) * docs: note websiteUrl https validation in createEnvelope (from encryption4all/postguard-js#95) --------- Co-authored-by: dobby-yivi-agent[bot] <275734547+dobby-yivi-agent[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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.
Summary
Updates
docs/repos/postguard-outlook-addon.mdafter postguard-outlook-addon#67 and postguard-outlook-addon#63.pg.encryptionEnabledmailbox-wide setting,x-pg-encrypt-on-sendheader, persistent compose banner, fail-closed/fail-open contract viacommittedToEncrypt.OnNewMessageComposealongsideOnMessageSendandsrc/lib/settings.ts.promptBeforeOpen: truedefault and thepg.allowOptimisticDialogopt-in.displayDialogAsynccode excerpt replaced with the new optimistic-vs-prompt block, pinned to current master HEAD (2fcc56e).Closes #76.
Verification
npm run docs:build— passes (~5s).dist/repos/postguard-outlook-addon.htmlcontains all new identifiers:OnNewMessageCompose,x-pg-encrypt-on-send,pg.encryptionEnabled,pg.allowOptimisticDialog,committedToEncrypt, "Settings view".Reviewer quickstart
git fetch origin && git checkout update-outlook-addon-defaults-off-fail-closed && npm install && npm run docs:devThen open
/repos/postguard-outlook-addonin the preview and check the Encryption defaults and per-draft control, Settings view, and Per-platform behaviour sections.