pl_mail README

The project's README from github.com/karatektus/pl_mail. As one markdown file: README.md.

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.

📱 Apps for your phone

Both connect to your own plMail server.


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

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.
Choosing an icon Choosing its colours
Icons — ten of them, a blue horn among them. Colourways — each icon in its own colours, or any of 32.

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. From another machine, open https:// and the server's address instead; the browser warns about the self-signed certificate once and lets you continue.

TrueNAS

plMail is in the TrueNAS app catalogue. Apps → Discover Apps, search for plMail, and install it. The form asks for one thing, a database password; everything else has a default that works.

Reach it on port 30519, and put a reverse proxy in front of it if it should be reachable from outside. Updates arrive through the catalogue like any other app's.

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.

pl_mail (karatektus/pl_mail)

Searching Database…

这是什么?plMail 是一个自托管、Gmail 风格的邮件客户端,连接你已有的 IMAP、Gmail 和 Outlook 邮箱,把它们同步到你自己的 PostgreSQL 数据库,并在浏览器中为你提供统一的收件箱、搜索框和一套标签。
它是邮件服务器,还是只是针对我已有邮件的客户端?只是客户端。它不从互联网接收邮件,也不托管你的域名——它把现有的 IMAP、Gmail 和 Outlook 账号同步到自己的数据库,让你在本地获得一个统一收件箱。
这个怎么运行?克隆仓库并运行“docker compose up”,然后打开服务器地址并创建你的账号。无需提前配置任何东西——密钥在首次启动时自动生成,公开地址在设置界面中设置。
连接 Gmail 或 Outlook 需要 OAuth 凭据吗?对于 Gmail 和 Outlook 账号,是的——你需要来自 Google 或 Microsoft 的 OAuth 凭据,手册会逐步讲解,包括用于 Gmail 即时推送的可选 Pub/Sub 主题。普通 IMAP 邮箱只需在设置中添加,无需额外配置。
如果我弄丢了生成的密钥文件会怎样?var/secrets/generated.env 中的加密密钥用于解锁存储在 PostgreSQL 中的邮箱凭据;如果你在没有单独备份的情况下丢失该文件,存储的邮箱密码将永远无法找回。
我能在 NAS 上而不是普通服务器上运行 plMail 吗?可以——plMail 已收录于 TrueNAS 应用目录,只需一个数据库密码即可安装;此外还为 linux/amd64 和 linux/arm64 发布了预构建的 Docker 镜像,可用于任何其他 Docker 主机。
会有任何邮件或 AI 数据离开我的网络吗?不会。凭据在写入数据库之前会先加密,可选的 AI 功能连接你自己网络中的 Ollama 实例运行,默认关闭,相关的任何数据都不会离开你的网络。
有移动应用吗?有——配套的 Android(karatektus/plmailandroid)和 iOS(karatektus/plmailios)应用都可连接你自己自托管的 plMail 服务器。
plMail 能自动把我的邮件分类到标签页吗?可以,既可以用始终给出相同结果的邮件头规则,也可以让本地 AI 模型阅读每封邮件;在 Gmail 上还有选项可让其中任一方式覆盖 Google 自己的分类结果,“报告”按钮可把错误反馈给管理员。
它带日历吗?带——日历就在邮件旁边,支持与 Google、Microsoft 和 CalDAV 双向同步,提供可拖拽移动的周视图网格、就地回复邀请,以及共享和预约链接。
界面的可定制程度如何?plMail 自带 41 套浅色和深色主题,十种应用/主屏图标各有 32 种配色,界面语言选项包括英语、德语和海盗模式。
Creator
karatektus
Size
31.6 MB
Stars
331
Updated
CommitOct 16
Age
3mo
Commits · 90 Days