Projektstart
This commit is contained in:
30
README.md
30
README.md
@@ -23,14 +23,38 @@ docker compose up --build
|
||||
- `GET /tenants/me` (auth)
|
||||
- `GET /mail/accounts` (auth)
|
||||
- `POST /mail/accounts` (auth)
|
||||
- `POST /mail/cleanup` (auth)
|
||||
- `POST /mail/cleanup` (auth) `{ mailboxAccountId, dryRun, unsubscribeEnabled, routingEnabled }`
|
||||
- `GET /jobs` (auth)
|
||||
- `GET /jobs/:id/events` (auth)
|
||||
- `GET /jobs/:id/stream?token=...` (auth via query token, SSE)
|
||||
- `GET /rules` (auth)
|
||||
- `POST /rules` (auth)
|
||||
- `PUT /rules/:id` (auth)
|
||||
- `DELETE /rules/:id` (auth)
|
||||
- `GET /admin/tenants` (admin)
|
||||
- `PUT /admin/tenants/:id` (admin)
|
||||
- `GET /admin/users` (admin)
|
||||
- `PUT /admin/users/:id` (admin)
|
||||
- `PUT /admin/users/:id/role` (admin)
|
||||
- `POST /admin/users/:id/reset` (admin)
|
||||
- `GET /admin/accounts` (admin)
|
||||
- `PUT /admin/accounts/:id` (admin)
|
||||
- `GET /admin/jobs` (admin)
|
||||
- `GET /admin/jobs/:id/events` (admin)
|
||||
|
||||
## Notes
|
||||
- Newsletter detection will use `List-Unsubscribe` headers + heuristics.
|
||||
- Weblink unsubscribe is queued and handled by a worker (placeholder).
|
||||
- Worker currently scans headers for newsletter candidates (no destructive actions yet).
|
||||
- Weblink unsubscribe uses HTTP first, mailto fallback (SMTP required).
|
||||
- Worker scans headers and applies routing rules (MOVE/DELETE) when not in dry run.
|
||||
|
||||
## Seed data
|
||||
```bash
|
||||
cd backend
|
||||
DATABASE_URL=postgresql://mailcleaner:mailcleaner@localhost:5432/mailcleaner \\
|
||||
SEED_EMAIL=admin@simplemailcleaner.local \\
|
||||
SEED_PASSWORD=change-me-now \\
|
||||
npm run prisma:seed
|
||||
```
|
||||
- DSGVO: data storage is designed for tenant isolation; encryption at rest will be added.
|
||||
|
||||
## Environment
|
||||
|
||||
Reference in New Issue
Block a user