newsletter-to-web/newsletter-to-web
1
0
Fork 0
Code Issues 4 Pull Requests Projects Releases 5 Activity
Converts email newsletters to static HTML pages and an Atom feed.
70 Commits 2 Branches 6 Tags 518 KiB
Rust 79.4%
XSLT 15.8%
HTML 2.7%
Shell 2.1%
master
Go to file
Jacob Kiers 01912a6944
Some checks reported errors
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is passing
Details
continuous-integration/drone Build was killed
Details
Add changelog and relase v0.2.4 
Signed-off-by: Jacob Kiers <code@kiers.eu>
2024-06-27 18:21:38 +02:00
.cargo Build with rust v1.66 and cross v0.2.4 2022-12-16 18:42:38 +01:00
resources Add style sheet to the feed 2022-12-27 22:59:45 +01:00
src Allow specifying how many items go into the feed 2024-06-27 18:21:38 +02:00
systemd Add protection features to service definition 2024-06-27 17:52:23 +02:00
.drone.jsonnet Update build toolchain 2024-06-27 18:21:38 +02:00
.gitignore Ignore more directories 2022-08-06 23:00:57 +02:00
Cargo.lock Add changelog and relase v0.2.4 2024-06-27 18:21:38 +02:00
Cargo.toml Add changelog and relase v0.2.4 2024-06-27 18:21:38 +02:00
CHANGELOG.md Add changelog and relase v0.2.4 2024-06-27 18:21:38 +02:00
README.md Add link to releases page 2022-12-27 12:27:27 +01:00

README.md

Newsletter to Web

Converts a newsletter to and Atom feed and static HTML files.

Usage

Get the latest release from the releases page.

Getting help

For help, use

  • newsletter-to-web help
  • newsletter-to-web help <subcommand>.

Basic usage

First, download all messages from the IMAP mail server and store them in the data/ directory:

newsletter-to-web fetch-from-imap -s <imap.example.com> -u <email@example.com> -p <password>

Then, convert them to an Atom feed, using newsletters.example.com as the base domain:

newsletter-to-web --include-html build-feed newsletters.example.org

This will put the output in the output/ directory. The Atom feed will be in output/feed.xml, together with a very simple index.html file pointing to the feed. It will also add an HTML file for every email with the HTML content.

The feed will already contain the full HTML, so it can easily be read from a feed reader.

Features

Receive email

  • IMAP integration
  • Direct feeding of email message
  • Read from Maildir
  • Read from MBOX

Convert email to HTML

  • Generate static HTML files
  • Parse and add unsubscribe link
  • Where possible: remove tracking pixels / images
  • Prevent loading of scripts / images without user interaction

Create ATOM feed

  • Single feed for everything
  • One feed per newsletter
  • Index feed (containing all newsletters)?