himalaya/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

• Added systemd service in assets/ folder.

Changed

• Made the global --config|-c option repeatable: the first option is considered the path to the main config, and successive options are considered partial overrides #184.
• Changed the envelope list options (see envelope list --help for more details):
  • The folder argument became a flag --folder <name>.
  • The query argument has been added at the end of the command to filter and sort results #39.

Fixed

• Fixed watch IMAP envelopes when folder was empty [#179].
• Prevent parsing of undefined config options #188.

[1.0.0-beta.3] - 2024-02-25

Added

• Added account check-up command.
• Added wizard warning about google passwords #41.

Changed

• Removed account configurations flatten level in order to improve diagnostic errors, due to a bug in clap. This means that accounts need to be prefixed by accounts: [my-account] becomes [accounts.my-account]. It also opens doors for interface-specific configurations.

• Rolled back cargo feature additions from the previous release. It was a mistake: the amount of features was too big, the code (both CLI and lib) was too hard to maintain. Cargo features kept: imap, maildir, notmuch, smtp, sendmail, account-sync, account-discovery, pgp-gpg, pgp-commands and pgp-native.

• Moved sync.strategy to folder.sync.filter.

• Changed location of the synchronization data from $XDG_DATA_HOME/himalaya/<account-name> to $XDG_DATA_HOME/pimalaya/email/sync/<account-name>-cache.

• Changed location of the synchronization cache from sync.dir to $XDG_CACHE_HOME/pimalaya/email/sync/<hash>/.

• Replaced id mapping database SQLite by sled, a pure key-val store written in Rust to improve portability of the tool. Therefore, id aliases are reset.

• Improved pre and post edit choices interaction #58.

• Improved account synchronization performances, making it 50% faster than mbsync and 370% faster than OfflineIMAP.

• Changed envelope.watch.{event}.{hook}: hooks can now be cumulated. For example it is possible to send a system notification and execute a shell command when receiving a new envelope:

  envelope.watch.received.notify.summary = "New message from {sender}"
  envelope.watch.received.notify.body = "{subject}"
  envelope.watch.received.cmd = "echo {id} >> /tmp/new-email-counter"
  

Fixed

• Fixed bug that was preventing watch placeholders to be replaced when using shell command hook.
• Fixed watch IMAP envelopes issue preventing events to be triggered.
• Fixed DNS account discovery priority issues.
• Fixed SMTP messages not properly sent to all recipients #172.
• Fixed backend feature badly linked, leading to reply and forward message errors #173.

1.0.0-beta.2 - 2024-01-27

Added

• Added cargo feature wizard, enabled by default.
• Added one cargo feature per backend feature:
  • account including account-configure, account-list, account-sync and the account-subcmd
  • folder including folder-add, folder-list, folder-expunge, folder-purge, folder-delete and the folder-subcmd
  • envelope including envelope-list, envelope-watch, envelope-get and the envelope-subcmd
  • flag including flag-add, flag-set, flag-remove and the flag-subcmd
  • message including message-read, message-write, message-mailto, message-reply, message-forward, message-copy, message-move, message-delete, message-save, message-send and the message-subcmd
  • attachment including attachment-download and the attachment-subcmd
  • template including template-write, template-reply, template-forward, template-save, template-send and the template-subcmd
• Added wizard capability to autodetect IMAP and SMTP configurations, based on the Thunderbird Autoconfiguration standard.
• Added back Notmuch backend features.

Changed

• Renamed folder create to folder add in order to better match types. An alias has been set up, so both create and add still work.

Fixed

• Fixed default command: running himalaya without argument lists envelopes, as it used to be in previous versions.
• Fixed bug when listing envelopes with backend = "imap", sync.enable = true and envelope.watch.backend = "imap" led to unwanted IMAP connection creation (which slowed down the listing).
• Fixed builds related to enabled cargo features.

1.0.0-beta - 2024-01-01

Few major concepts changed:

• The concept of Backend and Sender changed. The Sender does not exist anymore (it is now a backend feature). 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 backend 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.
• TOML 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 plugged yet).
• Added cargo feature sendmail (not plugged 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.received.notify.summary = "📬 New message from {sender}": customize the notification summary (title)
    • envelope.watch.received.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.
• 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.
• Moved maildir-* config options to maildir.*.
• Moved imap-* config options to imap.*.
• Moved notmuch-* config options to notmuch.*.
• Moved sendmail-* config options to sendmail.*.
• Moved smtp-* config options to smtp.*.
• Replaced options imap-ssl, imap-starttls and imap-insecure by imap.encryption:
  • imap.encryption = "tls" | true: use required encryption (SSL/TLS)
  • imap.encryption = "start-tls": use opportunistic encryption (StartTLS)
  • imap.encryption = "none" | false: do not use any encryption
• Replaced options smtp-ssl, smtp-starttls and smtp-insecure by smtp.encryption:
  • smtp.encryption = "tls" | true: use required encryption (SSL/TLS)
  • smtp.encryption = "start-tls": use opportunistic encryption (StartTLS)
  • smtp.encryption = "none" | false: do not use any encryption

Removed

• Disabled temporarily the notmuch backend because it needs to be refactored using the backend features system (it should be reimplemented soon).
• Disabled temporarily the search and sort command because they need to be refactored, see #39.
• Removed the notify command (replaced by the new watch command).
• Removed all global options except for display-name, signature, signature-delim and downloads-dir.

0.9.0 - 2023-08-28

Added

• Added 3 new cargo features:
  • pgp-commands: enables the commands PGP backend (enabled by default, same behaviour as before)
  • pgp-gpg: enables the GPG backend (requires the gpgme lib on the system)
  • pgp-native: enables the native PGP backend
• Added account configuration pgp to configure the way PGP operations are performed.

Changed

• Moved email-writing-encrypt-cmdto pgp.encrypt-cmd.
• Moved email-reading-decrypt-cmd to pgp-decrypt-cmd.
• Moved email-writing-sign-cmd to pgp.sign-cmd.
• Moved email-reading-verify-cmd to pgp.verify-cmd.

0.8.4 - 2023-07-18

Fixed

• Fixed windows releases due to cargo deps typo.

0.8.3 - 2023-07-18

Fixed

• Fixed windows releases due to coredump crate compilation error.
• Fixed macos releases due to macos 12 System Integrity Protection.

0.8.2 - 2023-07-18

Changed

• Made the code async using the tokio async runtime.
• On Linux, made the kernel keyring the default one (the one based on keyutils).

Fixed

• Fixed the way folder aliases are resolved. In some case, aliases were resolved CLI side and lib side, which led to alias errors #95.

0.8.1 - 2023-06-15

Added

• Implemented OAuth 2.0 refresh token flow for IMAP and SMTP, which means that access tokens are now automatically refreshed and is transparent for users.
• Added imap-oauth2-redirect-host and smtp-oauth2-redirect-host options to customize the redirect server host name (default: localhost).
• Added imap-oauth2-redirect-port and smtp-oauth2-redirect-port options to customize the redirect server port (default: 9999).
• Added email-listing-datetime-fmt to customize envelopes datetime format. See format spec here.
• Added email-listing-local-datetime to transform envelopes datetime's timezone to the user's local one. For example, if the user's local is set to UTC, the envelope date 2023-06-15T09:00:00+02:00 becomes 2023-06-15T07:00:00-00:00.

Fixed

• Fixed missing < and > around Message-ID and In-Reply-To headers.

0.8.0 - 2023-06-03

Added

• Added keyring support, which means Himalaya can now use your system's global keyring to get/set sensitive data like passwords or tokens.
• Added required IMAP option imap-auth and SMTP option smtp-auth. Possible values: passwd, oauth2.
• Added OAuth 2.0 support for IMAP and SMTP.
• Added passwords and OAuth 2.0 configuration via the wizard.
• Added email-sending-save-copy option to control whenever a copy of any sent email should be saved in the sent folder defined in folder-aliases.
• Imported id mapper from the lib, which means that the id mapping is now done by the CLI.
• Added BackendConfig to AccountConfig::backend to match sender implementation.
• Added support for pipeline commands, which means commands can be either a single command (string) or piped commands (list of strings). It applies for:
  • email-writing-verify-cmd
  • email-writing-decrypt-cmd
  • email-writing-sign-cmd
  • email-writing-encrypt-cmd

Changed

• Changed release archive extensions from .tar.gz to .tgz.

• Moved wizard module into domains (config, account, backend…).

• [BREAKING] Changed the way secrets are managed. A secret is a sensitive data like passwords or tokens. There is 3 possible ways to declare a secret in the config file:

  • { raw = <secret> } for the raw secret as string (unsafe, not recommended),
  • { cmd = <secret-cmd> } for command that exposes the secret,
  • { keyring = <secret-entry> } for entry in your system's global keyring that contains the secret.

  This applies for:

  • imap-passwd
  • imap-oauth2-client-secret
  • imap-oauth2-access-token
  • imap-oauth2-refresh-token
  • smtp-passwd
  • smtp-oauth2-client-secret
  • smtp-oauth2-access-token
  • smtp-oauth2-refresh-token

Fixed

• Fixed Windows releases corrupted archives.

Removed

• [BREAKING] Removed -s|--sanitize option. It is done by default now, except if the -t|--mime-type html is set.
• [BREAKING] Removed native-tls support, rustls-tls is now the only TLS provider available. Removed in consequence native-tls, rustls-tls and rustls-native-certs cargo features.

0.7.3 - 2023-05-01

Fixed

• Fixed Windows releases (due to typo in the github action script).
• Fixed unit tests.

0.7.2 - 2023-05-01

Added

• Added create and delete folder commands #54.

• Added generated completions and man pages to releases #43.

• Added new account config option sync-folders-strategy which allows to choose a folders synchronization strategy #59:

  • sync-folders-strategy = "all": synchronize all existing folders for the current account
  • sync-folders-strategy.include = ["folder1", "folder2", …]: synchronize only the given folders for the current account
  • sync-folders-strategy.exclude = ["folder1", "folder2", …]: synchronizes all folders except the given ones for the current account

  Also added new account sync arguments that override the account config option:

  • -A|--all-folders: include all folders to the synchronization.
  • -F|--include-folder: include given folders to the synchronization. They can be repeated -F folder1 folder2 or -F folder1 -F folder2.
  • -x|--exclude-folder: exclude given folders from the synchronization. They can be repeated -x folder1 folder2 or -x folder1 -F folder2.

• Added cargo features native-tls (default), rustls-tls and rustls-native-certs.

Changed

• Made global options truly global, which means they can be used everywhere (not only before commands but also after) #60.
• Replaced reply all -a argument with -A because it conflicted with the global option -a|--account.
• Replaced himalaya-lib by pimalaya-email.
• Renamed feature vendored to native-tls-vendored.
• Removed the develop branch, all the development is now done on the master branch.

Fixed

• Fixed config deserialization issue with email-hooks and email-reading-format.
• Fixed flags case sensitivity.

0.7.1 - 2023-02-14

Added

• Added command folders expunge that deletes all emails marked for deletion.

Changed

• Changed the location of the documentation.

Fixed

• Fixed broken links in README.md.

Removed

• Removed the maildir-backend cargo feature, it is now included by default.
• Removed issues section on GitHub, now issues need to be opened by sending an email at ~soywod/pimalaya@todo.sr.ht.

0.7.0 - 2023-02-08

Added

• Added offline support with the account sync command to synchronize a backend to a local Maildir backend.
• Added the flag --disable-cache to not use the local Maildir backend.
• Added the email composer (from its own repository).
• Added Musl builds to releases.
• Added himalaya man command to generate man page.

Changed

• Made commands read, attachments, flags, copy, move, delete accept multiple ids.
• Flipped arguments ids and folder for commands copy and move in order the folder not to be considered as an id.

Fixed

• Fixed missing folder aliases.

Removed

• Removed the -a|--attachment argument from write, reply and forward commands. Instead you can attach documents directly from the template using the syntax <#part filename=/path/to/you/document.ext>.
• Removed the -e|--encrypt flag from write, reply and forward commands. Instead you can encrypt and sign parts directly from the template using the syntax <#part type=text/plain encrypt=command sign=command>Hello!<#/part>.
• Removed the -l|--log-level option, use instead the RUST_LOG environment variable (see the wiki)

0.6.1 - 2022-10-12

Added

• Added -s|--sanitize flag for the read command.

Changed

• Changed the behaviour of the -t|--mime-type argument of the read command. It is less strict now: if no part is found for the given MIME type, it will fallback to the other one. For example, giving -t html will show in priority HTML parts, but if none of them are found it will show plain parts instead (and vice versa).
• Sanitization is not done by default when using the read command, the flag -s|--sanitize needs to be explicitly provided.

Fixed

• Fixed empty text bodies when reading html part on plain text email.

0.6.0 - 2022-10-10

Changed

• Separated the CLI from the lib module.

  The source code has been split into subrepositories:

  • The email logic has been extracted from the CLI and placed in a lib on SourceHut
  • The vim plugin is now in a dedicated repository on SourceHut as well
  • This repository only contains the CLI source code (it was not possible to move it to SourceHut because of cross platform builds)

• [BREAKING] Renamed -m|--mailbox to -f|--folder

• [BREAKING] Refactored config system.

  The configuration has been rethought in order to be more intuitive and structured. Here are the breaking changes for the global config:

  • name becomes display-name and is not mandatory anymore
  • signature-delimiter becomes signature-delim
  • default-page-size has been moved to folder-listing-page-size and email-listing-page-size
  • notify-cmd, notify-query and watch-cmds have been removed from the global config (available in account config only)
  • folder-aliases has been added to the global config (previously known as mailboxes from the account config)
  • email-reading-headers, email-reading-format, email-reading-decrypt-cmd, email-writing-encrypt-cmd and email-hooks have been added

  The account config inherits the same breaking changes from the global config, plus:

  • imap-* requires backend = "imap"
  • maildir-* requires backend = "maildir"
  • notmuch-* requires backend = "notmuch"
  • smtp-* requires sender = "smtp"
  • sendmail-* requires sender = "sendmail"
  • pgp-encrypt-cmd becomes email-writing-encrypt-cmd
  • pgp-decrypt-cmd becomes email-reading-decrypt-cmd
  • mailboxes becomes folder-aliases
  • hooks becomes email-hooks
  • maildir-dir becomes maildir-root-dir
  • notmuch-database-dir becomes notmuch-db-path

0.5.10 - 2022-03-20

Fixed

• Fixed flag commands.
• Fixed Windows build.

0.5.9 - 2022-03-12

Added

• SMTP pre-send hook
• Customize headers to show at the top of a read message

Changed

• Improve attachments command

Fixed

• In-Reply-To not set properly when replying to a message
• Cc missing or invalid when replying to a message
• Notmuch backend hangs
• Maildir e2e tests
• JSON API for listings

0.5.8 - 2022-03-04

Added

• Flowed format support
• List accounts command
• One cargo feature per backend

Changed

• Vim doc about mailbox pickers

Fixed

• Some emojis break the table layout
• Bad sender and date in reply and forward template

0.5.7 - 2022-03-01

Added

• Notmuch support

Fixed

• Build failure due to imap version
• No tilde expansion in maildir-dir
• Unknown command SORT

Changed

• [BREAKING] Replace inbox-folder, sent-folder and draft-folder by a generic hashmap mailboxes
• Display short envelopes id for maildir and notmuch backends

0.5.6 - 2022-02-22

Added

• Sort command
• Maildir support

Fixed

• Suffix to downloaded attachments with same name

0.5.5 - 2022-02-08

Added

• Contributing guide
• Notify query config option
• End-to-end encryption

Fixed

• Multiple recipients issue
• Cannot parse address

0.5.4 - 2022-02-05

Fixed

• Add attachments with save and send commands
• Invalid sequence set

0.5.3 - 2022-02-03

Added

• Activate rust-imap logs when trace mode is enabled
• Set up cargo deployment

0.5.2 - 2022-02-02

Fixed

• Blur in list msg screenshot
• Make inbox, sent and drafts folders customizable
• Vim plugin get focused msg id
• Nix run issue
• Range not displayed when fetch fails
• Blank lines and spaces in text/plain parts
• Watch command
• Mailbox telescope.nvim preview

Removed

• The wiki git submodule

0.5.1 - 2021-10-24

Added

• Disable color feature
• --max-width|-w argument to restrict listing table width

Fixed

• Error when receiving notification from notify command

Changed

• Remove error when empty subject
• Vim plugin does not render anymore the msg by itself, it uses the one available from the CLI

0.5.0 - 2021-10-10

Added

• Mailto support
• Remove previous signature when replying/forwarding a message
• Config option signature-delimiter to customize the signature delimiter (default to -- \n)
• Expand tilde and env vars for downloads-dir and signature

Changed

• [BREAKING] Folder structure, message management, JSON API and Vim plugin
• Pagination for list and search cmd starts from 1 instead of 0
• Errors management with anyhow

Fixed

• Panic on flags command
• Make more use of serde
• Write message vim plugin
• Invalid encoding when sending message
• Pagination reset current account
• New/reply/forward from Vim plugin since Tpl refactor

0.4.0 - 2021-06-03

Added

• Add ability to change account in with the Vim plugin
• Add possibility to make Himalaya default email app

Changed

• [BREAKING] Short version of reply --all arg is now -A to avoid conflicts with --attachment|-a
• Template management

Fixed

• \Seen flag when moving a message
• Attachments arg for reply and forward commands
• Vim doc

Removed

• Content-Type from templates

0.3.2 - 2021-05-08

Added

• Mailbox attributes
• Wiki entry about new messages counter
• Copy/move/delete a message in vim

Changed

• Get signature from file
• [BREAKING] Split idle command into two commands:
  • notify: Runs notify-cmd when a new message arrives to the server
  • watch: Runs watch-cmds when any change occurs on the server

Removed

• .exe extension from release binaries

0.3.1 - 2021-05-04

Added

• Send message via stdin

Fixed

• Table with subject containing \r, \n or \t
• Overflow panic when shrink column
• Vim plugin empty mailbox message

0.3.0 - 2021-04-28

Fixed

• IDLE mode after network interruption
• Output redirected to stderr
• Refactor table system
• Editon file format on Linux
• Show email address when name not available

Removed

• --log-level|-l arg (replaced by default RUST_LOG env var from env_logger)

0.2.7 - 2021-04-24

Added

• Default page size to config
• Custom config path
• Setting idle-hook-cmds

Changed

• Plain logger with env_logger
• Refresh email list on load buffer

Fixed

• Improve config compatibility on Windows
• Vim table containing emoji

0.2.6 - 2021-04-17

Added

• Insecure TLS option
• Completion subcommands
• Vim flags to enable telescope preview and to choose picker

Changed

• Make install.sh POSIX compliant

Fixed

• SMTP port
• Save msg upon error
• Answered flag not set
• Panic when downloads-dir does not exist
• Idle mode incorrect new message notification

0.2.5 - 2021-04-12

Fixed

• Expunge mbox after move and delete cmd
• JSON output

0.2.4 - 2021-04-09

Added

• Wiki entry for Gmail users
• Info logs for copy/move/delete cmd + silent mode
• --raw arg for read cmd

Changed

• Refactor output system + log levels

0.2.3 - 2021-04-08

Added

• Telescope support

Fixed

• Unicode chars breaks the view
• Copy/move incomplete (missing parts)

0.2.2 - 2021-04-04

Added

• w alias for write cmd

Fixed

• attachments cmd logs
• Page size arg search cmd

0.2.1 - 2021-04-04

Added

• IDLE support
• Improve choice after editing msg
• Flags management
• Copy feature
• Move feature
• Delete feature
• Signature support
• Add attachment(s) to a message (CLI)

Changed

• Errors management with error_chain

Fixed

• Missing FLAGS column in messages table
• Subtract with overflow if next page empty

0.2.0 - 2021-03-10

Added

• STARTTLS support
• Flags

Changed

• JSON support

0.1.0 - 2021-01-17

Added

• Parse TOML config
• Populate Config struct from TOML
• Set up IMAP connection
• List new emails
• Set up CLI arg parser
• List mailboxes command
• Text and HTML previews
• Set up SMTP connection
• Write new email
• Write new email
• Reply, reply all and forward
• Download attachments
• Merge Email with Msg
• List command with pagination
• Icon in table when attachment is present
• Multi-account
• Password from command
• Set up README