Source code Paperboy

IMAP email checker and GTK notifier
#

About

Paperboy is a simple CLI application which sends a GTK notification when an email is received, allowing the user to just click on the callback button to open the webmail associated to the account.

In order to do what's been described:

How to use

Usage is very straightforward, as all the options are passed via a configuration file:

paperboy -c ~/.config/paperboy

The configuration is YAML-formatted and should respect the following sample structure:

accounts:
  - alias: "Name"
    address: "email@addre.ss"
    password: "pa$word"
    hostname: "imap.host.name"
    proto: "imaps"
    port: "993"
    url: "https://url.to/webmail"

Scheduling checks

In order to make recurrent IMAP checks, there're multiple cron options. Below the implementation using systemd timers to run a check every 5 minutes:

[Unit]
Description=PaperBoy timer

[Timer]
Unit=paperboy.service
OnCalendar=*-*-* *:00/5
Persistent=true

[Install]
WantedBy=timers.target
[Unit]
Description=PaperBoy service

[Service]
Type=simple
ExecStart=%h/.local/bin/paperboy -c  %h/.config/paperboy
systemctl --user daemon-reload
systemctl --user enable paperboy.timer
systemctl --user start paperboy.timer

Installation

Package manager

Installation from repositories is only available for Solus-Project users which have enabled Theca repository:

eopkg it -y paperboy

Run latest source code

git clone https://github.com/streambinder/paperboy.git
cd paperboy
make
make install

Dependencies

Dependencies on which the code base is relying to be provenly working follow:

NameTypeVersion
libgtk-3compile3.24.16
libyamlcompile0.2.2
libcurlcompile7.69.1
xdg-openruntime1.1.3