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"

The application runs checks at a certain interval, configurable in seconds, using a dedicated flag:

paperboy -c ~/.config/paperboy -i 60

Configuring a service unit

[Unit]
Description=PaperBoy service
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
ExecStart=paperboy -c  %h/.config/paperboy
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target
systemctl --user daemon-reload
systemctl --user enable paperboy.service
systemctl --user start paperboy.service

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