Files
NewSzxcn-Email/README.en.md
T

50 lines
1.2 KiB
Markdown
Raw Normal View History

2026-08-02 15:07:16 +08:00
# NewSzxcn-Email
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
NewSzxcn-Email is a self-hosted, manageable, ready-to-run open-source email system.
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
Live site: [mail.newszxcn.com](https://mail.newszxcn.com)
2026-08-02 06:03:59 +08:00
## Features
2026-08-02 15:07:16 +08:00
- Webmail: inbox, compose, attachments, drafts, search, stars, labels, read/unread
- Multi-mailbox and multi-domain management, DKIM, DNS checks, forwarding
- Account management, mailbox quotas, permission quotas, registration, mailbox requests
- Admin console, all mail, send queue, system settings
- Postfix, Dovecot, Rspamd, SQLite, Docker single-container deployment
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
## Screenshots
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
Replace these images when needed:
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
- `docs/screenshots/mail-preview.png`
- `docs/screenshots/compose-preview.png`
- `docs/screenshots/admin-preview.png`
- `docs/screenshots/client-preview.png`
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
## Stack
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
- Backend: Go
- Frontend: React + TypeScript + shadcn/ui
- Database: SQLite
- Mail stack: Postfix + Dovecot + Rspamd
- Deployment: Docker / Docker Compose
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
## Quick Deploy
2026-08-02 06:03:59 +08:00
```bash
cd deploy
cp .env.example .env
2026-08-02 15:07:16 +08:00
# Edit domain, public URL, admin email, and admin password
docker compose up -d --build
2026-08-02 06:03:59 +08:00
```
2026-08-02 15:07:16 +08:00
Public mail delivery requires MX, SPF, DKIM, DMARC, and open mail ports.
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
## Note
2026-08-02 06:03:59 +08:00
2026-08-02 15:07:16 +08:00
This is the NewSzxcn maintained version. Future changes are based on this repository.
2026-08-02 06:03:59 +08:00
## License
[MIT](./LICENSE)