swiftbar-imap-counter

An IMAP counter plugin for SwiftBar by Jon Lasser [email protected]

This project is under an MIT license. See the license for specifics.

Requirements

• SwiftBar
• Python 3 (Tested on Python 3.8.6; should work on the 3.8.2 that ships with Big Sur.)

Installation

1. Install SwiftBar
2. Unpack swiftbar-imap-counter in an appropriate place
3. cd into the directory where you have unpacked swiftbar-imap-counter
4. Copy imap_counterrc.EXAMPLE to $HOME/.imap_counterrc: cp imap_counterrc.EXAMPLE ~/.imap_counterrc
5. Change the permissions on .imap_counterrc to 0600: chmod 0600 ~/.imap_counterrc
6. Edit $HOME/.imap_counterrc for your specific IMAP configuration. At a minimum, you will need to update the server, username, and password. Many third-party providers (e.g., FastMail may have specific instructions, and some will require an application-specific password. Even if it's optional, you should probably enable SSL or TLS, depending on what your provider has available. (NOTE: I don't have a mail server that allows me to test inline TLS, so that support is speculative.)
7. Link imap_counter.py to your SwiftBar plugin directory with a filename that indicates the frequency with which to check for mail updates. For example, if your SwiftBar plugin directory is in $HOME/Documents/SwiftBar and you want to run at 15 minute intervals: ln -s imap_counter.py ~/Documents/SwiftBar/imap-counter.15m.py

Use

It sits there in your menu bar and tells you how many messages you've got. That's it, that's the plugin.

Getting Help

You can mail me at my address above, or file an issue in GitHub. Some mail problems may be beyond my ability to resolve, but I'll do my best to help!

Helping Me

I've put some features I'd like to implement in the TODO file. Pull requests gladly accepted!