#email #cli #systray #notification

app buzz

A simple system tray application for notifying about unseen e-mail

26 stable releases

1.6.0 Apr 22, 2021
1.5.0 Jan 28, 2021
1.4.1 Nov 28, 2020
1.4.0 Jul 7, 2020
0.3.0 May 15, 2017

#8 in Email

Download history 1/week @ 2021-01-16 14/week @ 2021-01-23 8/week @ 2021-01-30 50/week @ 2021-02-06 98/week @ 2021-02-13 1/week @ 2021-02-20 3/week @ 2021-02-27 1/week @ 2021-03-06 1/week @ 2021-03-13 55/week @ 2021-03-20 27/week @ 2021-03-27 27/week @ 2021-04-03 32/week @ 2021-04-10 34/week @ 2021-04-17 43/week @ 2021-04-24 7/week @ 2021-05-01

110 downloads per month

MIT/Apache and maybe LGPL-2.1/LGPL-3.0

73KB
390 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:

no new e-mail new e-mail

new e-mail notification

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

~8–12MB
~313K SLoC