443 lines
18 KiB
Markdown
443 lines
18 KiB
Markdown
<div align="center">
|
|
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="public/branding/Bulwark_Logo_with_Lettering_White_and_Color.svg" />
|
|
<source media="(prefers-color-scheme: light)" srcset="public/branding/Bulwark_Logo_with_Lettering_Dark_Color.svg" />
|
|
<img src="public/branding/Bulwark_Logo_with_Lettering_Dark_Color.svg" alt="Bulwark Webmail" width="280" />
|
|
</picture>
|
|
|
|
# Bulwark Webmail
|
|
|
|
A modern, self-hosted webmail client for [Stalwart Mail Server](https://stalw.art/).<br/>
|
|
Built with Next.js and the JMAP protocol.
|
|
|
|
[](LICENSE)
|
|
[](https://discord.gg/tYCujymGrT)
|
|
[](CHANGELOG.md)
|
|
[](https://ghcr.io/bulwarkmail/webmail)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## Screenshots
|
|
|
|
<table>
|
|
<tr>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/inbox.png" width="100%" alt="Inbox — three-pane layout with sidebar, email list, and viewer (dark mode)">
|
|
|
|
**Mail** — Three-pane layout with sidebar, email list, and viewer
|
|
|
|
</td>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/calendar.png" width="100%" alt="Calendar">
|
|
|
|
**Calendar** — Month, week, day, and agenda views with event management
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/contacts.png" width="100%" alt="Contacts">
|
|
|
|
**Contacts** — Contact management with groups and vCard support
|
|
|
|
</td>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/files.png" width="100%" alt="File browser">
|
|
|
|
**Files** — Cloud file browser with upload, preview, and folder navigation
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<details>
|
|
<summary>More screenshots</summary>
|
|
<table>
|
|
<tr>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/inbox%20whitemode.png" width="100%" alt="Inbox — light mode">
|
|
|
|
**Light mode** — Full theme support with intelligent color transformation
|
|
|
|
</td>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/settings.png" width="100%" alt="Settings">
|
|
|
|
**Settings** — Appearance, identities, filters, templates, and more
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="50%">
|
|
|
|
<img src="screenshots/login.png" width="100%" alt="Login page">
|
|
|
|
**Login** — Configurable branding with OAuth2/OIDC and 2FA support
|
|
|
|
</td>
|
|
<td width="50%">
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</details>
|
|
|
|
## Features
|
|
|
|
### Mail
|
|
|
|
- **Read, compose, reply, reply-all, forward** with rich HTML rendering and a Tiptap-based rich text editor (inline image upload, drag-and-drop embedding)
|
|
- **Threading** — Gmail-style inline expansion with thread navigation; optional conversation threading toggle
|
|
- **Unified mailbox** — view emails across all accounts in a single list
|
|
- **Draft auto-save** with discard confirmation; full draft editing with identity preservation
|
|
- **Attachments** — upload, download, and inline preview; attachment-keyword warning if a file is forgotten
|
|
- **Search** — full-text with JMAP filter panel, search chips, cross-mailbox queries, wildcard support, and OR conditions
|
|
- **Batch operations** — multi-select with checkboxes, archive, delete, move, tag
|
|
- **Archive modes** — archive directly or organize archived mail by year or month
|
|
- **Print** emails directly from the viewer
|
|
- **Answered/forwarded status icons** in email list and thread views
|
|
- **Multi-tag per email** with color labels, reorderable tags, and drag-and-drop tag assignment
|
|
- **Star/unstar** with configurable mark-as-read delay
|
|
- **Virtual scrolling** for large mailboxes
|
|
- **Quick reply** from the viewer
|
|
- **Hover actions** — configurable quick-action buttons on email rows with customizable placement
|
|
- **Sender avatars** — favicon-based with negative caching for performance
|
|
- **Recipient popover** for quick contact interaction
|
|
- **Plain text composer mode** and auto-select reply identity
|
|
- **Reply-to addresses** support in the composer
|
|
- **TNEF support** — extract Outlook `winmail.dat` message bodies and attachments automatically
|
|
- **message/rfc822 unwrapping** for embedded messages
|
|
- **Folder management** — create, rename, delete folders with icon picker and subfolder support
|
|
- **Tag counts** — unread and total counts displayed in sidebar
|
|
- **Browser history sync** — back/forward navigation mirrors mail view state
|
|
|
|
### Calendar
|
|
|
|
- **Month, week, day, and agenda views** with mini-calendar sidebar and a dedicated task list view
|
|
- **Event hover preview** popover with configurable details
|
|
- **Drag-and-drop rescheduling**, click-drag or double-click creation, edge-resize (15-min snap)
|
|
- **Recurring events** with edit/delete scope (this / this and following / all) and client-side recurrence expansion
|
|
- **Participant scheduling** — iMIP invitations sent on create and update (RFC 5545/6047 compliant), organizer/attendee UI, RSVP with trust assessment
|
|
- **Inline calendar invitations** in email viewer — auto-detect `.ics`, RSVP, import
|
|
- **iCalendar import** with preview, bulk create, and UID deduplication
|
|
- **iCal / webcal subscriptions** with editing and batch import
|
|
- **Birthday calendar** — auto-generated from contacts
|
|
- **Virtual locations** — video conference URLs as first-class event fields
|
|
- **Task management** — create, edit, and track tasks with due dates, priority, and completion status; external CalDAV client detection (Thunderbird)
|
|
- **Shared calendars** with visual grouping in the sidebar
|
|
- **CalDAV discovery** with automatic calendar home resolution for multi-account setups
|
|
- **Week numbers** in mini-calendar sidebar
|
|
- **Notifications** with configurable sound, alert persistence, and sound picker with preview playback
|
|
- **Real-time sync** via JMAP push
|
|
|
|
### Contacts
|
|
|
|
- **Contact management** with JMAP sync (RFC 9553/9610) and local fallback
|
|
- **Multiple address books** — create, rename, drag-and-drop between books, with editor picker in contact form
|
|
- **Collapsible sidebar** with address book grouping and bulk operations
|
|
- **Contact groups** with group expansion and member management
|
|
- **vCard import/export** (RFC 6350) with duplicate detection
|
|
- **Trusted senders** stored in a dedicated JMAP address book
|
|
- **Autocomplete** in composer (To/Cc/Bcc)
|
|
- **Bulk operations** — multi-select, delete, group add, export
|
|
|
|
### Filters & Automation
|
|
|
|
- **Server-side email filters** via JMAP Sieve Scripts (RFC 9661)
|
|
- **Visual rule builder** — conditions (From, To, Subject, Size, Body…) and actions (Move, Forward, Star, Discard…) with an expanded visual view
|
|
- **External rule preservation** — rules authored in other clients are displayed and preserved
|
|
- **Raw Sieve editor** with syntax validation
|
|
- **Vacation responder** with date range scheduling and sidebar indicator
|
|
- **Email templates** — reusable, categorized, with placeholder auto-fill (`{{recipientName}}`, `{{date}}`, etc.)
|
|
|
|
### Files
|
|
|
|
- **File browser** with JMAP FileNode cloud storage (Stalwart native)
|
|
- **Upload and download** files with progress tracking, folder upload, and streamed WebDAV PUT (no in-memory buffering)
|
|
- **Dynamic upload limits** — respects the server-configured maximum upload size
|
|
- **Folder navigation** with breadcrumb path and tree sidebar
|
|
- **Grid and list views** with sorting by name, size, or date
|
|
- **Clipboard operations** — cut, copy, paste, duplicate files
|
|
- **File preview** for images, text, audio, video, and more
|
|
- **Favorites and recent files** for quick access
|
|
- **Bulk operations** — multi-select, delete, move, download
|
|
|
|
### Security & Privacy
|
|
|
|
- **External content blocked** by default — trusted senders list for auto-load
|
|
- **HTML sanitization** via DOMPurify with XSS prevention
|
|
- **S/MIME** — manage certificates, sign outgoing mail, encrypt to recipients, decrypt messages, and verify signatures; self-signed certificate detection; legacy 3DES / PBE support; per-account key isolation
|
|
- **SPF/DKIM/DMARC** status indicators
|
|
- **OAuth2/OIDC with PKCE** for SSO (Keycloak, Authentik, or built-in), with OAuth-only mode, OAuth app passwords, configurable scopes, and non-interactive SSO for embedded/iframe deployments
|
|
- **TOTP two-factor authentication**
|
|
- **Account security panel** — manage passwords and 2FA via Stalwart admin API
|
|
- **"Remember me"** — AES-256-GCM encrypted httpOnly cookie (opt-in)
|
|
- **Security headers** — enforced CSP with per-request nonce, X-Frame-Options, Referrer-Policy; SSRF redirect validation; PDF iframe sandbox; IP spoofing prevention
|
|
- **Plugin hardening** — dangerous-pattern detection, admin approval required, secure HTTP proxy API (no auth-header exposure)
|
|
- **Newsletter unsubscribe** (RFC 2369)
|
|
|
|
### Interface
|
|
|
|
- **Three-pane layout** — sidebar, email list, viewer with resizable columns
|
|
- **Dark and light themes** with intelligent email color transformation
|
|
- **Always-light email rendering** option for problematic HTML messages in dark theme
|
|
- **Responsive** — desktop sidebar + mobile bottom tab bar with tablet support
|
|
- **Keyboard shortcuts** — full navigation without a mouse
|
|
- **Drag-and-drop** email organization between mailboxes and tag assignment
|
|
- **Interactive guided tour** — onboarding walkthrough for new users
|
|
- **Right-click context menus**, toast notifications with undo, form validation with shake feedback
|
|
- **Customizable toolbar** position, custom favicon, sidebar/login logos, and login page branding
|
|
- **Sidebar apps** — pin custom tools to the navigation rail with drag-and-drop reordering, mobile visibility toggles, and inline or new-tab launch modes
|
|
- **Settings sync** — preferences synchronized with the server (encrypted)
|
|
- **Storage quota** display
|
|
- **Version badge** in settings
|
|
- **Focused mode** with proper viewport bounds
|
|
- **Accessibility** — WCAG AA contrast, reduced-motion support, focus trap, screen reader live regions
|
|
|
|
### Internationalization
|
|
|
|
14 languages: English · Français · 日本語 · Español · Italiano · Deutsch · Nederlands · Português · Русский · 한국어 · Polski · Latviešu · 简体中文 · Українська
|
|
|
|
Automatic browser detection with persistent preference. Configurable locale URL prefix via `NEXT_PUBLIC_LOCALE_PREFIX`.
|
|
|
|
### Identity Management
|
|
|
|
- **Multiple sender identities** with per-identity signatures
|
|
- **Automatic identity synchronization** and refresh to keep the identity manager aligned with server-side changes
|
|
- **Sub-addressing** — `user+tag@domain.com` with contextual tag suggestions
|
|
- **Identity badges** in viewer and email list
|
|
|
|
### Multi-Account
|
|
|
|
- **Up to 5 simultaneous accounts** with instant switching and per-account session persistence
|
|
- **Account switcher** with connection status, default account selection, and per-account logout
|
|
- **Per-account settings** — encrypted settings storage with server-side sync
|
|
- **Shared folders** across accounts
|
|
- **Custom JMAP server endpoints** — optionally let users connect to any JMAP server from the login form (`ALLOW_CUSTOM_JMAP_ENDPOINT`)
|
|
|
|
### Admin & Extensibility
|
|
|
|
- **Stalwart admin dashboard** — sidebar access with reorganized dashboard and dedicated policy sections
|
|
- **Plugin system** — schema-driven admin config UI, render and intercept hooks, `onAvatarResolve` and i18n APIs, calendar event action slots, forced enable/disable and managed policy enforcement
|
|
- **Themes** — upload, enforce, and manage admin-controlled themes with ZIP bundles
|
|
- **Extension marketplace** — browse and install plugins/themes from a configurable directory (`EXTENSION_DIRECTORY_URL`)
|
|
- **Bundled plugins** — Jitsi Meet calendar integration
|
|
|
|
### Operations
|
|
|
|
- **Progressive Web App (PWA)** — installable with service worker, install prompt, and dynamic manifest (app name, description, icons, theme and background colors)
|
|
- **Automatic update check** — server logs when a newer release is available
|
|
- **Logging categories** with `text` or `json` formats for log aggregation
|
|
- **Docker images** — release (`main`) and development (`dev`) channels on GHCR
|
|
- **Demo mode** — try the webmail with fixture data for emails, calendars, contacts, files, filters, identities, and mailboxes — no mail server required
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
### Docker (recommended)
|
|
|
|
```bash
|
|
docker run -d -p 3000:3000 \
|
|
-e JMAP_SERVER_URL=https://mail.example.com \
|
|
ghcr.io/bulwarkmail/webmail:latest
|
|
```
|
|
|
|
Or with Docker Compose:
|
|
|
|
```bash
|
|
cp .env.example .env.local
|
|
# Edit .env.local — set JMAP_SERVER_URL
|
|
docker compose up -d
|
|
```
|
|
|
|
### From Source
|
|
|
|
```bash
|
|
git clone https://github.com/bulwarkmail/webmail.git
|
|
cd webmail
|
|
npm install
|
|
cp .env.example .env.local
|
|
# Edit .env.local — set JMAP_SERVER_URL
|
|
npm run build && npm start
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
npm run dev # Start dev server (mock JMAP server included)
|
|
npm run typecheck # Type checking
|
|
npm run lint # Linting
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Edit `.env.local`:
|
|
|
|
```env
|
|
# Required
|
|
JMAP_SERVER_URL=https://mail.example.com
|
|
|
|
# Optional
|
|
APP_NAME=My Webmail
|
|
```
|
|
|
|
All variables are **runtime** — Docker deployments can be configured without rebuilding.
|
|
|
|
<details>
|
|
<summary>Server Listen Address</summary>
|
|
|
|
```env
|
|
HOSTNAME=0.0.0.0 # Default; use "::" for IPv6
|
|
PORT=3000 # Default listen port
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>OAuth2/OIDC (SSO)</summary>
|
|
|
|
```env
|
|
OAUTH_ENABLED=true
|
|
OAUTH_CLIENT_ID=webmail
|
|
OAUTH_CLIENT_SECRET= # optional, for confidential clients
|
|
OAUTH_CLIENT_SECRET_FILE= # Path to a file containing the client secret
|
|
OAUTH_ISSUER_URL= # optional, for external IdPs (Keycloak, Authentik)
|
|
```
|
|
|
|
Endpoints are auto-discovered via `.well-known/oauth-authorization-server` or `.well-known/openid-configuration`.
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Remember Me & Settings Sync</summary>
|
|
|
|
```env
|
|
SESSION_SECRET=your-secret-key # Generate with: openssl rand -base64 32
|
|
SESSION_SECRET_FILE=/session-secret # Path to a file containing the session secret
|
|
|
|
SETTINGS_SYNC_ENABLED=true # Persist encrypted user settings on the server
|
|
SETTINGS_DATA_DIR=./data/settings # Storage location (mount a volume in Docker)
|
|
```
|
|
|
|
Credentials encrypted with AES-256-GCM, stored in an httpOnly cookie (30-day expiry).
|
|
Settings sync stores per-account preferences encrypted at rest and requires `SESSION_SECRET`.
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Custom JMAP Endpoint</summary>
|
|
|
|
```env
|
|
ALLOW_CUSTOM_JMAP_ENDPOINT=true # Shows a "JMAP Server" field on login
|
|
```
|
|
|
|
Lets users connect to any JMAP-compatible server. External servers must CORS-allow the webmail origin.
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Branding & PWA</summary>
|
|
|
|
```env
|
|
APP_NAME=My Webmail
|
|
APP_SHORT_NAME=Webmail # Home-screen label on mobile
|
|
APP_DESCRIPTION=Your personal mail # Shown during PWA install
|
|
|
|
FAVICON_URL=/branding/favicon.svg
|
|
PWA_ICON_URL=/branding/icon.svg # Falls back to FAVICON_URL
|
|
PWA_THEME_COLOR=#3b82f6 # Browser chrome color
|
|
PWA_BACKGROUND_COLOR=#ffffff # PWA splash background
|
|
|
|
APP_LOGO_LIGHT_URL=/branding/logo-light.svg
|
|
APP_LOGO_DARK_URL=/branding/logo-dark.svg
|
|
LOGIN_LOGO_LIGHT_URL=/branding/login-light.svg
|
|
LOGIN_LOGO_DARK_URL=/branding/login-dark.svg
|
|
|
|
LOGIN_COMPANY_NAME=My Company
|
|
LOGIN_WEBSITE_URL=https://example.com
|
|
LOGIN_IMPRINT_URL=https://example.com/imprint
|
|
LOGIN_PRIVACY_POLICY_URL=https://example.com/privacy
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Extension Directory</summary>
|
|
|
|
```env
|
|
EXTENSION_DIRECTORY_URL=https://extensions.bulwarkmail.org
|
|
```
|
|
|
|
Enables the admin marketplace for browsing and installing plugins and themes.
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Stalwart Integration & Logging</summary>
|
|
|
|
```env
|
|
STALWART_FEATURES=true # Password change, sieve filters, etc.
|
|
STALWART_API_URL=https://admin.example.com # If reverse proxy doesn't forward /api/*
|
|
|
|
LOG_FORMAT=text # "text" or "json"
|
|
LOG_LEVEL=info # "error", "warn", "info", "debug"
|
|
```
|
|
|
|
</details>
|
|
|
|
## Keyboard Shortcuts
|
|
|
|
| Key | Action |
|
|
| ------------- | ----------------------- |
|
|
| `j` / `k` | Navigate between emails |
|
|
| `Enter` / `o` | Open email |
|
|
| `Esc` | Close / deselect |
|
|
| `c` | Compose |
|
|
| `r` / `R` | Reply / Reply all |
|
|
| `f` | Forward |
|
|
| `s` | Star |
|
|
| `e` | Archive |
|
|
| `#` | Delete |
|
|
| `/` | Search |
|
|
| `?` | Show all shortcuts |
|
|
|
|
## Tech Stack
|
|
|
|
| | |
|
|
| ------------- | ------------------------------------------------- |
|
|
| **Framework** | [Next.js 16](https://nextjs.org/) with App Router |
|
|
| **Language** | TypeScript |
|
|
| **Styling** | [Tailwind CSS v4](https://tailwindcss.com/) |
|
|
| **State** | [Zustand](https://zustand-demo.pmnd.rs/) |
|
|
| **Protocol** | Custom JMAP client (RFC 8620) |
|
|
| **i18n** | [next-intl](https://next-intl-docs.vercel.app/) |
|
|
| **Icons** | [Lucide React](https://lucide.dev/) |
|
|
|
|
## Why Stalwart?
|
|
|
|
[Stalwart](https://github.com/stalwartlabs/mail-server) is a mail server written in Rust with **native JMAP support** — not IMAP/SMTP with JMAP bolted on. It handles JMAP, IMAP, SMTP, and ManageSieve in a single binary. Self-hosted, no third-party dependencies.
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
|
|
## License
|
|
|
|
[GNU AGPL v3](LICENSE)
|
|
|
|
This repository also preserves the original MIT attribution notice for the
|
|
fork lineage in [NOTICE](NOTICE).
|
|
|
|
## Acknowledgments
|
|
|
|
Thanks to [root-fr/jmap-webmail](https://github.com/root-fr/jmap-webmail/) and [@ma2t](https://github.com/ma2t) for doing most of the groundwork that this project builds upon.
|