Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/servusdei2018/protoncheck
@ProtonMail module for waybar/polybar/yabar/i3blocks
https://github.com/servusdei2018/protoncheck
i3blocks-modules polybar-module protonmail waybar yabar
Last synced: about 1 month ago
JSON representation
@ProtonMail module for waybar/polybar/yabar/i3blocks
- Host: GitHub
- URL: https://github.com/servusdei2018/protoncheck
- Owner: servusdei2018
- License: mit
- Archived: true
- Created: 2021-12-26T02:22:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-13T16:00:10.000Z (almost 3 years ago)
- Last Synced: 2024-08-03T03:01:34.471Z (5 months ago)
- Topics: i3blocks-modules, polybar-module, protonmail, waybar, yabar
- Language: Go
- Homepage:
- Size: 61.5 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-Polybar - ProtonCheck
- awesome-go-extra - ARCHIVED - 12-26T02:22:47Z|2022-02-13T16:00:10Z| (Go Tools / Other Software)
README
# protoncheck
[](https://goreportcard.com/report/github.com/servusdei2018/protoncheck) [](https://pkg.go.dev/github.com/servusdei2018/protoncheck) [](https://sonarcloud.io/project/overview?id=servusdei2018_protoncheck) [](https://github.com/avelino/awesome-go)
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](https://github.com/servusdei2018/protoncheck/releases/latest).
## 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:
```json
"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:
```yaml
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](https://github.com/crabvk) for making [bar-protonmail](https://github.com/crabvk/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.
[](https://www.paypal.com/donate?business=S9REMLHZB64NQ&no_recurring=0&item_name=Help+fund+my+college+tuition+and+open-source+work¤cy_code=USD)