Skip to main content

Get notifications and unread messages count from ProtonMail (Waybar/Polybar module)

Project description

New message notifications and unread messages count from ProtonMail (Waybar/Polybar module)

Dependencies

  • proton-client >= 0.7.1 (not available on pypi.org)
  • ttf-font-awesome (default badge: )
  • libnotify (new email notifications, can be disabled with -dn flag)
  • libcanberra (optional, notification sound)

To display notifications you must have a notification daemon running on your system.

Install

ArchLinux and derivatives

AUR package

Other distros

git clone https://github.com/crabvk/bar-protonmail.git
# WARN: Checkout to the latest tag, don't use master branch.
pip install -e .

And now you can execute ~/.local/bin/bar-protonmail

Use

First, you need to authenticate the client:

bar-protonmail auth

then just run bar-protonmail or bar-protonmail -f polybar. Session, cache and log are stored in ~/.cache/bar-protonmail.

Waybar config example

~/.config/waybar/config

"modules-right": {
    "custom/protonmail"
}

"custom/protonmail": {
    "exec": "bar-protonmail",
    "return-type": "json",
    "interval": 10,
    "tooltip": false,
    "on-click": "xdg-open https://mail.proton.me/u/0/inbox"
}

~/.config/waybar/style.css

#custom-protonmail.unread {
    color: white;
}
#custom-protonmail.inaccurate {
    color: darkorange;
}
#custom-protonmail.error {
    color: darkred;
}

Polybar config example

modules-right = protonmail
...
[module/protonmail]
type = custom/script
exec = bar-protonmail -f polybar
interval = 10
click-left = xdg-open https://mail.proton.me/u/0/inbox

Script arguments

See bar-protonmail -h for the list of arguments with descriptions.
Possible values for -s, --sound can be found with:

ls /usr/share/sounds/freedesktop/stereo/ | cut -d. -f1

for example -s message-new-instant.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bar_protonmail-1.2.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

bar_protonmail-1.2.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file bar_protonmail-1.2.0.tar.gz.

File metadata

  • Download URL: bar_protonmail-1.2.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.11.5 Linux/6.6.1-zen1-1-zen

File hashes

Hashes for bar_protonmail-1.2.0.tar.gz
Algorithm Hash digest
SHA256 2e9aff1193ca8486127a40392620f91f39b23617170b6e2754b15db316b3b2e5
MD5 7ce865fb57e0c44a5c5164230fd0a64d
BLAKE2b-256 0f52b9b64b892baeeaf80495635ea47eb1aa2eee80e0f4787bec524a64ad9efa

See more details on using hashes here.

File details

Details for the file bar_protonmail-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: bar_protonmail-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.11.5 Linux/6.6.1-zen1-1-zen

File hashes

Hashes for bar_protonmail-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85d75dfb0f144396354c8b8331aedc642ed67a6bbd27b6163da5a3cf1b2c8a09
MD5 24fe6b9390edbaa655e102b96d8350bc
BLAKE2b-256 62856ec4a435e579ae01761ade45bbdc87ba425ad020ea2f3c6b2f182e2c15d8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page