beenull/himalaya
1
0
Fork 0
mirror of https://github.com/soywod/himalaya.git synced 2024-11-22 11:00:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

init changelog

Browse source
This commit is contained in:
Clément DOUIN 2023-12-19 17:44:16 +01:00
parent 77f5e590b8
commit 9632508dc7
No known key found for this signature in database
GPG key ID: 353E4A18EE0FAB72
1 changed files with 61 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
CHANGELOG.md
View file

@ -7,6 +7,67 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
Few major concepts changed:
- The concept of backend and sender changed. The sender does not exist anymore (it is now a backend). A backend is now a set of features like add folders, list envelopes or send raw message. The backend of every single feature can be customized in the configuration file, which gives users more flexibility. Here the list of features that can be customized:
- `backend` *(required)*: the backend used by default by all backend features (`maildir`, `imap` or `notmuch`)
- `folder.add.backend`: override the backend used for creating folders (`maildir`, `imap` or `notmuch`)
- `folder.list.backend`: override the backend used for listing folders (`maildir`, `imap` or `notmuch`)
- `folder.expunge.backend`: override the backend used for expunging folders (`maildir`, `imap` or `notmuch`)
- `folder.purge.backend`: override the backend used for purging folders (`maildir`, `imap` or `notmuch`)
- `folder.delete.backend`: override the backend used for deleting folders (`maildir`, `imap` or `notmuch`)
- `envelope.list.backend`: override the backend used for listing envelopes (`maildir`, `imap` or `notmuch`)
- `envelope.get.backend`: override the backend used for getting envelopes (`maildir`, `imap` or `notmuch`)
- `envelope.watch.backend`: override the backend used for watching envelopes (`maildir`, `imap` or `notmuch`)
- `flag.add.backend`: override the backend used for adding flags (`maildir`, `imap` or `notmuch`)
- `flag.set.backend`: override the backend used for setting flags (`maildir`, `imap` or `notmuch`)
- `flag.remove.backend`: override the backend used for removing flags (`maildir`, `imap` or `notmuch`)
- `message.send.backend` *(required)*: override the backend used for sending messages (`sendmail` or `smtp`)
- `message.read.backend`: override the backend used for reading messages (`maildir`, `imap` or `notmuch`)
- `message.write.backend`: override the backend used for adding flags (`maildir`, `imap` or `notmuch`)
- `message.copy.backend`: override the backend used for copying messages (`maildir`, `imap` or `notmuch`)
- `message.move.backend`: override the backend used for moving messages (`maildir`, `imap` or `notmuch`)
- The CLI API changed: every command is now prefixed by its domain following the format `himalaya <domain> <action>`. List of domain available by running `himalaya -h` and list of actions for a domain by running `himalaya <domain> -h`.
- Configuration file options use now the dot notation rather than the dash notation. For example, `folder-listing-page-size` became `folder.list.page-size`. See the changed section below for more details.
### Added
- Added cargo feature `maildir` (not working yet).
- Added cargo feature `sendmail` (not working yet).
- Added watch hooks `envelope.watch.received` (when a new envelope is received) and `envelope.watch.any` (for any other event related to envelopes). A watch hook can be:
- A shell command: `envelope.watch.any.cmd = "mbsync -a"`
- A system notification:
- `envelope.watch.any.notify.summary = "📬 New message from {sender}"`: customize the notification summary (title)
- `envelope.watch.any.notify.body = "{subject}"`: customize the notification body (content)
*Available placeholders: id, subject, sender, sender.name, sender.address, recipient, recipient.name, recipient.address.*
- Added watch support for Maildir backend features.
### Changed
- Renamed cargo feature `imap-backend` → `imap`.
- Renamed cargo feature `notmuch-backend` → `notmuch`.
- Renamed cargo feature `smtp-sender` → `smtp`.
- Disabled temporarily the `notmuch` backend because it needs to be refactored using the backend features system (it should be reimplemented soon).
- Changed the goal of the config option `backend`: it is now the default backend used for all backend features. Valid backends: `imap`, `maildir`, `notmuch`.
- Moved `folder-aliases` config option to `folder.alias(es)`.
- Moved `folder-listing-page-size` config option to `folder.list.page-size`.
- Moved `email-listing-page-size` config option to `envelope.list.page-size`.
- Moved `email-listing-datetime-fmt` config option to `envelope.list.datetime-fmt`.
- Moved `email-listing-datetime-local-tz` config option to `envelope.list.datetime-local-tz`.
- Moved `email-reading-headers` config option to `message.read.headers`.
- Moved `email-reading-format` config option to `message.read.format`.
- Moved `email-writing-headers` config option to `message.write.headers`.
- Move `email-sending-save-copy` config option to `message.send.save-copy`.
- Move `email-hooks.pre-send` config option to `message.send.pre-hook`.
- Moved `sync` config option to `sync.enable`.
- Moved `sync-dir` config option to `sync.dir`.
- Moved `sync-folders-strategy` config option to `sync.strategy`.
### Removed
- Removed all global options except for `display-name`, `signature`, `signature-delim` and `downloads-dir`.
- Removed the `notify` command (replaced by the new `watch` command).
## [0.9.0] - 2023-08-28 ## [0.9.0] - 2023-08-28
### Added ### Added