docs(e2e): document mail-sink secret format, de-personalize example (BUNYIP-272) #337

Merged

David merged 3 commits from docs/BUNYIP-272-e2e-mail-secret-format into main

2026-07-04 16:44:46 +02:00

vas2000-work commented

2026-07-04 06:11:45 +02:00

Owner

What

Documents the e2e mail-sink secret format and de-personalizes the example (BUNYIP-272).

BUNYIP-150 stood up the email-driven specs reading from a Stalwart mailbox via E2E_MAIL_SINK_URL, but the README example hardcoded the personal nate@a8n.run. This:

Adds a "Mail-sink secret format" section spelling out the exact URL shape: https://<url-encoded-email>:<application-password>@<jmap-host>, why the @ must be %40-encoded, that the password is a per-mailbox application password, and that the host is mail.a8n.run.
Updates the env-table example to a dedicated e2e%40a8n.run placeholder and flags that a personal mailbox must not be used.
Lists the operator provisioning steps (create the dedicated Stalwart mailbox, generate an app password, set E2E_STAGING_MAIL_SINK_URL / E2E_MAIL_SINK_URL, re-run).

Scope

Docs only. The env is already configurable (E2E_MAIL_SINK_URL / E2E_STAGING_MAIL_SINK_URL), so repointing to a dedicated mailbox is a secret-value change - no code change. Account creation, setting the secret, and the confirming re-run are operator-side (they need a Stalwart admin), so those ACs remain for the operator; this PR satisfies the "document the secret format" AC.

#BUNYIP-272

## What Documents the e2e mail-sink secret format and de-personalizes the example (BUNYIP-272). BUNYIP-150 stood up the email-driven specs reading from a Stalwart mailbox via `E2E_MAIL_SINK_URL`, but the README example hardcoded the personal `nate@a8n.run`. This: - Adds a "Mail-sink secret format" section spelling out the exact URL shape: `https://<url-encoded-email>:<application-password>@<jmap-host>`, why the `@` must be `%40`-encoded, that the password is a per-mailbox application password, and that the host is `mail.a8n.run`. - Updates the env-table example to a dedicated `e2e%40a8n.run` placeholder and flags that a personal mailbox must not be used. - Lists the operator provisioning steps (create the dedicated Stalwart mailbox, generate an app password, set `E2E_STAGING_MAIL_SINK_URL` / `E2E_MAIL_SINK_URL`, re-run). ## Scope Docs only. The env is already configurable (`E2E_MAIL_SINK_URL` / `E2E_STAGING_MAIL_SINK_URL`), so repointing to a dedicated mailbox is a secret-value change - no code change. Account creation, setting the secret, and the confirming re-run are operator-side (they need a Stalwart admin), so those ACs remain for the operator; this PR satisfies the "document the secret format" AC. #BUNYIP-272

vas2000-work added 1 commit

2026-07-04 06:11:45 +02:00

docs(e2e): document the mail-sink secret format, de-personalize the example (BUNYIP-272)

E2E / Playwright against deployment (pull_request) Successful in 30s

Details

Check / fmt + clippy + build + tests (pull_request) Successful in 19m15s

Details

7beea244eb

The e2e email-driven specs read token links from a Stalwart mailbox via E2E_MAIL_SINK_URL, whose example hardcoded the personal nate@a8n.run account (BUNYIP-150). Document the exact secret shape (URL-encoded dedicated mailbox address, application password, JMAP base host) in a dedicated section, update the env-table example to a dedicated e2e%40a8n.run placeholder, and spell out the operator provisioning steps. The env is already configurable, so repointing to a dedicated mailbox is a secret-value change plus this documentation; account creation and the secret set stay operator-side.

#BUNYIP-272

vas2000-work added 1 commit

2026-07-04 06:36:24 +02:00

Merge branch 'main' into docs/BUNYIP-272-e2e-mail-secret-format

E2E / Playwright against deployment (pull_request) Successful in 1m18s

Details

Check / fmt + clippy + build + tests (pull_request) Successful in 11m4s

Details

b4de9af38f