Paul LütznerandClaude Opus 5 d0d18e3059 feat(ai): the setup wizard asks once, and takes no for an answer
The AI step, sitting with the other two admin steps because it configures
the install rather than a person's mailbox — and last of the three,
because it is the only one that can reasonably be answered with "no".
Mail credentials and integrations decide whether the app works at all.

SATISFIED MEANS ANSWERED, NOT ENABLED

"No thank you" is a complete answer and has to count as one, or the
wizard nags forever at every install that does not want this — which
will be most of them. So persist() writes the row even when every box is
empty, and isSatisfied() asks only whether a row exists.

That is deliberately weaker than the sibling steps, and it has to be: the
strongest available signal of "decided against" is indistinguishable from
"never opened" unless something is written down when they say no. The row
IS that record — the only way one appears is somebody pressing the button
here or in Admin -> AI.

FOUR PLACES, NOT ONE

Adding a step touches the enum case (the ordering), the icon match, the
requiresAdmin match, and OnboardingController::STEP_PATTERN. The last is
the one that does not update itself, and the comment above it is blunt
about the cost: a new case without it 404s AND takes the whole wizard
down with it, because the progress rail generates a URL for every
applicable step. The icon match is worse in a quieter way — non-exhaustive
is a fatal error, not a missing icon.

OnboardingStepCoverageTest exists to catch exactly this and passes.

The step renders the admin panel's own form, so there is one description
of these fields rather than two that drift. The aside spends half its
words on permission to skip, because that is the answer most installs
should give and a wizard that only explains how to say yes is a wizard
that pressures people into saying it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-26 17:54:59 +02:00
2026-07-28 12:33:46 +02:00
2026-06-24 14:51:50 +02:00
2026-06-24 14:51:50 +02:00
2026-07-21 16:18:46 +02:00
2026-07-31 15:45:26 +02:00
2026-07-28 12:33:46 +02:00
2026-07-02 13:12:28 +02:00
2026-07-31 12:28:04 +02:00
2026-07-30 16:40:31 +02:00
2026-07-28 15:44:19 +02:00

plMail

Self-hosted mail with a calendar beside it. Connect the mailboxes you already have — IMAP, Gmail, Outlook — and read them side by side in one inbox, on a server you own.

PHP Symfony PostgreSQL License

📖 Read the handbook →

Installing on Docker, Linux, WSL2, macOS or a NAS · every feature in detail · connecting Gmail and Outlook, with the exact permissions to tick · how the internals work. Also on the wiki and in docs/ — all three are built from the same files.


What it is

A mail client you host yourself. It connects to the mailboxes you already have — IMAP, Gmail, Outlook — syncs them into your own PostgreSQL database, and gives them one inbox, one search box and one set of labels in the browser.

It is not a mail server: it doesn't receive mail from the internet or host your domain. Because everything is synced locally, search runs against your database, and your mail stays readable when a provider doesn't.

The plMail inbox

Highlights

  • Every account in one place — IMAP, Gmail and Outlook side by side, sending aliases included. Credentials are encrypted before they touch the database.
  • New mail arrives on its own — IMAP IDLE, Gmail and Outlook push, browser notifications.
  • Search that means it — full text plus from:, subject:, label:, has:, before: and friends, completed as you type.
  • Filters as a tree — any/all/none, nested, restated in plain English and counted against real mail before you save. Apply one to mail that arrived before it existed.
  • A calendar beside the mail — two-way sync with Google, Microsoft and CalDAV, drag-to-move week grid, invitations answered in place, share and booking links.
  • Files where you keep them — attach from and save to Drive, Photos, OneDrive, Dropbox, Nextcloud and Immich.
  • Yours — two-factor auth, per-app JMAP passwords, 41 themes, English, German and Pirate.

A look around

Reading a thread Writing a message
Threads — replies collapse into one conversation. Compose — rich text, autocomplete, undo send.
Dark mode Calendar
Themes — 41 of them, light and dark. Calendar — docked beside the mail, or its own page.
Filters Admin
Filters — counted before you save. Admin — workers, push health, logs, queue.

Screenshots use demo data — none of the accounts, senders or messages shown are real.

Install

Images are published for linux/amd64 and linux/arm64. Nothing to fill in first: the secrets are generated on first start, and the public address is asked for on the setup screen.

Docker

git clone https://github.com/karatektus/pl_mail.git
cd pl_mail
docker compose up -d

Open https://localhost and create your account.

TrueNAS SCALE

  1. Create a dataset for plMail — say yourPool/yourDataSet/plmail.
  2. Open truenas.compose.yaml and change one line to that path:
    path_data: &path_data /mnt/yourPool/yourDataSet/plmail
    
  3. Apps → Discover → ⋮ → Install via YAML, paste the file, install.

Reach it on port 30080 and put a reverse proxy in front of it. Everything else in that file works as it is; each setting explains itself in place.

Then

Add an IMAP mailbox in Settings → Mail accounts and you're done. Gmail and Outlook need OAuth credentials from Google or Microsoft first — the handbook walks through both, including the optional Pub/Sub topic for instant Gmail delivery.

Back up two things, separately: the PostgreSQL data and var/secrets/generated.env. The database holds your mail; the key inside that file unlocks the credentials in it. Keeping them apart is the point — and losing the key means the stored mailbox passwords are gone.

Contributing

Bug reports and pull requests welcome — see CONTRIBUTING.md for the dev setup, the test suites and the console commands.

License

AGPL-3.0.

S
Description
Upstream source mirror for plMail webmail client
Readme AGPL-3.0
48 MiB
0 Stars 1 Watchers 0 Forks
Languages
PHP 69.1%
JavaScript 12.9%
Twig 9.9%
TypeScript 6.7%
CSS 1.2%
Other 0.1%