Go to file

Jon Gjengset ce57248de2 Use UIDs instead of sequence numbers The previous scheme caused some messages to not produce notifications when message sequence numbers were re-used. UIDs are never re-used, so this is not an issue.		2017-05-15 16:24:07 -04:00
src	Use UIDs instead of sequence numbers	2017-05-15 16:24:07 -04:00
.gitignore	First draft	2017-03-02 01:21:01 -05:00
Cargo.lock	update and clippy	2017-05-12 17:16:21 -04:00
Cargo.toml	No more git dependencies!	2017-05-04 19:17:32 -04:00
LICENSE-APACHE	First draft	2017-03-02 01:21:01 -05:00
LICENSE-MIT	First draft	2017-03-02 01:21:01 -05:00
README.md	First draft	2017-03-02 01:21:01 -05:00

README.md

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.

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"

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.

TODOs

click command
hover tooltip
customizeable folder