Awesome Go

protoncheck

CategorySoftware Packages
SubcategorySoftware written in Go.
Stars6

ProtonMail module for waybar/polybar/yabar/i3blocks.

About protoncheck

protoncheck 

Go Reference Awesome

awesome waybar/polybar/yabar/i3blocks module to check the amount of unread emails in a ProtonMail inbox.

Installation

You may compile protoncheck yourself or download a copy from the Releases.

Usage

Run protoncheck, using the --username and --password flags to supply your ProtonMail username and password, respectively. It will output the amount of unread emails in your inbox.

⚠️ Protoncheck doesn't work with accounts with 2FA enabled.

waybar Config

Below is a sample Waybar configuration to check your ProtonMail inbox every 30 seconds.

~/.config/waybar/config:

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

"custom/protoncheck": {
		"exec": "~/bin/protoncheck --username [email protected] --password PASSWORD",
		"format": " {}",
		"interval": 30,
		"on-click": "xdg-open https://mail.protonmail.com/inbox"
}

polybar Config

Below is a sample Polybar configuration to check your ProtonMail inbox every 30 seconds.

~/.config/polybar/config:

modules-right = protoncheck

[module/protoncheck]
type = custom/script
exec = ~/bin/protoncheck --username [email protected] --password PASSWORD | sed  's/^/ /'
interval = 30
click-left = xdg-open https://mail.protonmail.com/inbox

yabar Config

Below is a sample yabar configuration to check your ProtonMail inbox every 30 seconds.

~/.config/yabar/yabar.conf:

	title: {
		exec: ~/bin/protoncheck --username [email protected] --password PASSWORD | sed  's/^/ /';
		type: "periodic";
		interval: 30;
	}

i3blocks Config

Below is a sample i3blocks configuration to check your ProtonMail inbox every 30 seconds.

~/.config/i3blocks/config:

[protoncheck]
command=~/bin/protoncheck --username [email protected] --password PASSWORD | sed  's/^/ /'
interval=30
color=#A4C2F4

Credits

  • Special thank you to @crabvk for making bar-protonmail, without which I wouldn't have had the inspiration to make protoncheck.

Sponsoring

Work on protoncheck is done by volunteers in their free time, and takes time and effort. To show your appreciation and to provide continued motivation for work on this and other open source software, please send a donation.

Frequently Asked Questions

What is protoncheck?

protoncheck is a Software Packages library for the Go programming language. ProtonMail module for waybar/polybar/yabar/i3blocks.

How do I install protoncheck?

Install protoncheck with the Go module system using `go get servusdei2018/protoncheck`. Check the repository for the current installation instructions.

What category does protoncheck belong to?

protoncheck is listed under Software Packages, specifically Software written in Go..

← Back to Software written in Go.