Skip to content

Commit 99546b3

Browse files
committed
Add multiple features
1 parent f6be918 commit 99546b3

File tree

16 files changed

+1029
-16
lines changed

16 files changed

+1029
-16
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,26 @@ Email Explorer is a full-stack, serverless email client that runs entirely on yo
5151
- 📖 **[User Guides](docs/features/index.md)** - Complete documentation for all features
5252
- 🚀 **[Getting Started](#getting-started)** - Deploy in minutes
5353
- 🔐 **[Authentication](docs/features/authentication.md)** - Setup your first account
54+
- 🔑 **[Account Recovery](docs/features/account-recovery.md)** - Password reset via email
5455
- 👥 **[Admin Panel](docs/features/admin-panel.md)** - Manage users and permissions
5556
- ⚙️ **[Configuration](#configuration)** - Customize your deployment
5657

5758
## Overview
5859

5960
Email Explorer gives you a private, self-hosted email solution with a user-friendly web interface. By leveraging the Cloudflare ecosystem, it offers a cost-effective and scalable alternative to traditional email hosting. All your data is stored securely in your own R2 buckets and Durable Objects, giving you full control over your information.
6061

62+
### Screenshots
63+
64+
<div align="center">
65+
<img src="docs/home.png" alt="Email Explorer Home" width="600" />
66+
<p><em>Mailbox management and email list view</em></p>
67+
</div>
68+
69+
<div align="center">
70+
<img src="docs/new-email.png" alt="Email Composer" width="600" />
71+
<p><em>Rich text email composer with formatting options</em></p>
72+
</div>
73+
6174
## Why Email Explorer?
6275

6376
**🔒 Privacy First**
@@ -155,6 +168,9 @@ export default EmailExplorer({
155168
auth: {
156169
enabled: true
157170
// registerEnabled not specified = smart mode
171+
},
172+
accountRecovery: {
173+
fromEmail: 'noreply@yourdomain.com' // Optional: enable password reset via email
158174
}
159175
})
160176
```
@@ -181,8 +197,32 @@ export default EmailExplorer({
181197
enabled: false
182198
}
183199
})
200+
201+
// With Account Recovery
202+
export default EmailExplorer({
203+
auth: {
204+
enabled: true
205+
},
206+
accountRecovery: {
207+
fromEmail: 'noreply@yourdomain.com' // Email address to send password reset links from
208+
}
209+
})
184210
```
185211

212+
**Configuration Options:**
213+
214+
| Option | Type | Default | Description |
215+
|--------|------|---------|-------------|
216+
| `auth.enabled` | boolean | `true` | Enable/disable authentication |
217+
| `auth.registerEnabled` | boolean | `undefined` (smart mode) | Control user registration |
218+
| `accountRecovery.fromEmail` | string | `undefined` (disabled) | Enable password recovery via email |
219+
220+
**Account Recovery:**
221+
- When configured, users can reset forgotten passwords via email
222+
- The `fromEmail` address must be a valid email on your Cloudflare account
223+
- Requires [Cloudflare Email Sending](https://developers.cloudflare.com/email-routing/email-workers/send-email-workers/) to be enabled
224+
- See [Account Recovery Guide](docs/features/account-recovery.md) for more details
225+
186226
### First-Time Setup
187227

188228
1. **Deploy your worker** with smart mode enabled (default)
@@ -205,6 +245,7 @@ Comprehensive user guides are available for all features:
205245

206246
- **[Feature Documentation](docs/features/index.md)** - Complete user guides
207247
- [Authentication Guide](docs/features/authentication.md) - Account creation, login, and security
248+
- [Account Recovery Guide](docs/features/account-recovery.md) - Password reset via email
208249
- [Admin Panel Guide](docs/features/admin-panel.md) - User management and permissions
209250
- [Rich Text Editor Guide](docs/features/rich-text-editor.md) - Email formatting and composition
210251
- [Reply & Forward Guide](docs/features/reply-forward.md) - Email responses and threading
@@ -291,7 +332,6 @@ Planned features for future releases:
291332

292333
- [ ] Email templates for quick responses
293334
- [ ] Two-factor authentication (2FA)
294-
- [ ] Password reset via email
295335
- [ ] Email drafts auto-save
296336
- [ ] Conversation threading view
297337
- [ ] Emoji picker in composer
@@ -306,11 +346,13 @@ See [ROADMAP.md](ROADMAP.md) for detailed planning and progress.
306346
## Known Limitations
307347

308348
**Current Limitations:**
309-
- Password reset must be done by administrator (email reset coming soon)
310349
- No email draft auto-save (manual save only)
311350
- Image uploads not yet supported (URLs work)
312351
- Single mailbox per user account (multiple access supported)
313352

353+
**Optional Features:**
354+
- Password reset via email requires `accountRecovery.fromEmail` configuration
355+
314356
**Browser Compatibility:**
315357
- Modern browsers required (Chrome 90+, Firefox 88+, Safari 14+)
316358
- JavaScript must be enabled

0 commit comments

Comments
 (0)