26 stable releases
1.7.0-rc.3 | Dec 17, 2023 |
---|---|
1.7.0-rc.1 | Feb 19, 2022 |
1.6.0 | Apr 22, 2021 |
1.5.0 | Jan 28, 2021 |
0.3.0 | May 15, 2017 |
#23 in Email
132 downloads per month
78KB
459 lines
Introduction
Using mutt (or pine), but annoyed that it doesn't give you any notifications when you've received new emails? buzz is a simple tray application that detects new emails on IMAP servers using IDLE (push rather than pull). When it detects unseen messages, it shows a OSD style notification and changes the tray icon to indicate that you have new mail.
This project is a Rust fork of hasmail, which provides basically the same features, and is written in Go.
What does it look like:
Configuration
buzz looks for a
TOML
configuration file in ~/.config/buzz.toml
on startup. The
configuration file consists of a number of sections, each corresponding
to one account:
[gmail]
server = "imap.gmail.com"
port = 993
username = "jon@gmail.com"
pwcmd = "gnome-keyring-query get gmail_pw"
notificationcmd = "ssh -t somehost wall 'New gmail message!'" #Optional
Account fields
The value in []
can be anything (though avoid .
as it will be parsed
as a new TOML section), and is shown in the tooltip when new e-mails
arrive for an account. The options for an account are as follows:
server
: The address to connect to. MUST currently be SSL/TLS enabled.port
: The port to connect to.username
: Username for authentication.pwcmd
: Command to execute to get password for authentication.notificationcmd
: Additional command to be executed on new messages for this account.folder
: Name of the folder to watch (optional; defaults to "INBOX").
TODOs
-
click
command - hover tooltip
- customizeable folder
Dependencies
~17–52MB
~1M SLoC