postsack/README.md

76 lines
2.2 KiB
Markdown
Raw Normal View History

2021-11-14 13:50:14 +00:00
# Postsack
# What can go into core (web compatible!)?
- database only as trait
- importer only as trait
2021-11-14 13:50:14 +00:00
## Provides a high level visual overview of swaths of email
### Performance
2021-09-30 16:41:02 +00:00
It currently parses 632383 emails in ~160 seconds, so roughly `4.000` emails per second. This excludes (for now) attachments.
2021-12-11 09:30:28 +00:00
Update: It currently parses 632115 emails in ~56 seconds, so roughly `11.000` emails per second. This excludes (for now) attachments. (on M1)
2021-10-07 12:08:02 +00:00
## Open Issues
2021-11-14 13:50:14 +00:00
- [ ] check the feature.lru to see if it compiles without LRU
2021-12-12 09:40:42 +00:00
- [ ] build static linux binary via docker: Via Github Actions?
- [ ] try to build a static windows binary: Via Github Actions?
- [ ] try to build a macos binary: Via Github Actions?
2021-12-14 18:50:19 +00:00
- [ ] Demo Video
- [ ] Documentation
- [ ] wasm build?
2021-12-12 09:40:42 +00:00
## Windows Issues
- [ ] No Outlook support
- [ ] The `apple importer` fails
- [ ] Very much untested (it does run though)
2021-11-14 15:05:22 +00:00
2021-11-14 13:50:14 +00:00
## Future Options
- [ ] Add additional UI based on Druid, Iced or Native Cocoa
2021-10-07 12:08:02 +00:00
- [ ] maybe add blocking versions of the calls, too (in model)
2021-11-14 13:50:14 +00:00
- [ ] abstract over `Fields` and backend to have a generic way to display groupable information
- [ ] apply the window changes (no status etc) on startup, not just when loading main
- [ ] split up into multiple crates
- [ ] action when clicking an email?
2021-12-03 12:40:40 +00:00
- [ ] support light theme
2021-11-14 13:50:14 +00:00
- [ ] allow diving into splits/segments until there're no gropu bys anymore, but the last split can be opened full (to see the mails)
- [ ] remove unneeded dependencies and features
2021-12-03 12:40:40 +00:00
- [ ] add support for generating mail deletion rules based on the visible mails
- [ ] support more mail formats:
- [ ] outlook
- [ ] notmuch
- [ ] maildir
2021-11-14 13:50:14 +00:00
## Development
2021-12-12 09:40:42 +00:00
Generate a macOS bundle (requires [Cargo Bundle](https://github.com/burtonageo/cargo-bundle))
2021-11-14 13:50:14 +00:00
``` sh
2021-12-12 09:40:42 +00:00
./build_mac.sh
2021-11-14 13:50:14 +00:00
```
2021-11-14 15:05:22 +00:00
### Linux Dependencies
In order to build (and or run) on Linux, the following dependencies are needed:
#### Fedora
``` sh
# Development
sudo dnf install @development-tools glib cairo-devel pango-devel gdk-pixbux2-devel atk-devel gtk3 gtk3-devel libsqlite3x-devel
```
2021-12-12 09:40:42 +00:00
#### Ubuntu
2021-11-14 15:05:22 +00:00
``` sh
# Development
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev libsqlite3-dev
```