Skip to content

Update outlook-addon docs: default-off, fail-closed, new Settings view (postguard-outlook-addon#63, #67) #76

@dobby-coder

Description

@dobby-coder

The docs/repos/postguard-outlook-addon.md page is stale after two recently merged PRs that changed the add-in's defaults and Send-flow behavior. Update the docs page to reflect the new model.

What changed

From encryption4all/postguard-outlook-addon#67 — "Default encryption off + global toggle + banner + fail-closed send"

  • Default is now OFF. PostGuard is opt-in. New roaming setting pg.encryptionEnabled (default false) seeds every new draft. Old behavior was opt-out (default on).
  • Per-draft control via an internet header. x-pg-encrypt-on-send ("true" / "false") is the only thing OnMessageSend consults. Compose toggle writes only this header; the global setting just provides the seed value.
  • New OnNewMessageCompose launch event fires when a new compose / reply / forward opens. Seeds the per-draft header from the global default and paints the persistent in-message banner.
  • Persistent compose banner reflects the per-draft state.
  • Fail-closed when encryption was requested, fail-open otherwise. Once the header is read as "true" a committedToEncrypt latch flips, and every failure path now blocks the send via a Smart Alert. If the header is "false", absent, or unreadable, the handler releases the send in cleartext immediately — a PostGuard outage can no longer block an unencrypted send.

From encryption4all/postguard-outlook-addon#63 — "prompt before opening Yivi dialog by default"

  • displayDialogAsync now defaults to promptBeforeOpen: true. The Office "Allow" click is itself the gesture that opens the Yivi popup — reliable on every host including Safari without site-level popup permission.
  • New Settings view in the taskpane (gear icon, top-right) with toggle pg.allowOptimisticDialog. When enabled, the launchevent attempts the optimistic open and falls back to one prompted retry if blocked.

Where the docs are stale

docs/repos/postguard-outlook-addon.md:

  • The "Per-platform behaviour" table still describes the OLD optimistic-by-default flow ("Optimistic displayDialogAsync with promptBeforeOpen: false"). The new default is promptBeforeOpen: true, with optimistic mode behind the pg.allowOptimisticDialog opt-in toggle.
  • The "Architecture" section lists OnMessageSend but not the new OnNewMessageCompose launchevent.
  • No mention of the new global default-off setting pg.encryptionEnabled, the per-draft x-pg-encrypt-on-send header, the persistent banner, or the fail-closed/fail-open contract.
  • No mention of the in-taskpane Settings view (gear icon).
  • The code excerpt around displayDialogAsync shows promptBeforeOpen: false — that comment is now wrong for the default path.

Suggested edits

  • Update the "Per-platform behaviour" table to describe the new default (Office prompt → Allow → Yivi opens) and add a note about the pg.allowOptimisticDialog Settings toggle as the opt-in for one-click sends.
  • Add a new section (e.g. "Encryption defaults and per-draft control") covering: opt-in default, pg.encryptionEnabled global setting, x-pg-encrypt-on-send header, compose banner, fail-closed/fail-open contract.
  • Mention OnNewMessageCompose alongside OnMessageSend in the Architecture section and in any event-handler list.
  • Mention the in-taskpane Settings view (gear icon) and the two roaming settings exposed there.
  • Update the displayDialogAsync code excerpt's surrounding prose so the promptBeforeOpen comment reflects the new opt-in optimistic path.

Verify before pushing: npx vitepress build docs and check docs/.vitepress/dist/repos/postguard-outlook-addon.html renders the changes.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions