Skip to content

๐Ÿ—ž Paperboy is a CLI tool that delivers new posts from your favorite sites by email.

License

Notifications You must be signed in to change notification settings

eduardostuart/paperboy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

75 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Paperboy

Paperboy

ci

Paperboy is a CLI tool that delivers new posts from your favorite sites by email.

Installation

From binaries

Check out the release page for prebuilt versions of Paperboy.

Usage

Set these environment variable values:

SMTP_HOST="smtp.mailtrap.io"               # SMTP host
SMTP_PORT=2525                             # SMTP port
SMTP_USERNAME="username"                   # SMTP username
SMTP_PASSWORD="password"                   # SMTP password
SMTP_FROM="Paperboy <rss@domain.com>"      # the sender
MAIL_TO="email@domain.com"                 # the recipient
EMAIL_SUBJECT="Subject"                    # Email subject (optional)
Paperboy CLI

Usage: paperboy [OPTIONS] <COMMAND>

Commands:
  deliver  Deliver new posts from sites by email
  help     Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose...  More output per occurrence
  -q, --quiet...    Less output per occurrence
  -h, --help        Print help
  -V, --version     Print version

Deliver command

paperboy deliver email@domain subscriptions.txt template.hbs template_text.hbs
# Template example.: emails/daily_email.hbs

GitHub template

If you want an automatic and free way to receive daily "newspapers" using paperboy, take a look at the paperboy-template GitHub project.

Tests

cargo test

License

This code is distributed under the terms of MIT license. See LICENSE-MIT for details.

Image generated by DALL-E OpenAI.