#rss #atom

bin+lib rss2email

An RSS feed aggregator that notifies you of new posts via email

5 stable releases

2.0.0 Feb 6, 2024
1.1.1 Aug 22, 2023
1.1.0 Jul 10, 2023
1.0.1 Jan 3, 2023
0.1.0 Oct 21, 2022

#28 in Email

Download history 5/week @ 2023-10-31 1/week @ 2023-11-14 13/week @ 2023-11-21 17/week @ 2023-11-28 5/week @ 2023-12-12 10/week @ 2023-12-26 4/week @ 2024-01-16 10/week @ 2024-01-30 29/week @ 2024-02-06 48/week @ 2024-02-13

87 downloads per month

GPL-3.0 license

120KB
867 lines

Rss2Email

Build & Tests Crates.io docs.rs Minimum Supported Rust Version dependency status Docker Images Actively Maintained

A small program capable of aggregating content from multiple RSS/Atom feeds and mailing them to you in a practical summary email. Keep track of your favorite blogs that don't feature an update newsletter or similar service.

Example

Dependencies

You'll need Rust or Docker installed to compile this software.

Installation

Each release automatically publishes Docker images for x86 and arm on DockerHub. Note that these can only run on AWS Lambda. If you want to run them elsewhere through Docker, read here.

Alternatively, you can build this from source. Clone this repository and run:

cargo build --release

Check out the build from source section of the wiki for more information.

Configuration

Rss2email requires some environment variables to work. These can be provided either in your shell or as entries in a .env file.

  • EMAIL_ADDRESS: the mail address you will use to send the emails
  • RECIPIENT_ADDRESSES: comma delimited list of recipient email addresses
  • SUBJECT: the email subject (could be rss2email)
  • DAYS: this value indicates up to how many days in the past we go to search for entries
  • FEEDS: a list of semicolon-separated feed URLs.
    eg: "https://blog.rust-lang.org/feed.xml;https://www.linux.org/articles/index.rss"
  • EMAIL (optional, defaults to SendGrid): Which provider to use to send the email.
    For the supported providers, you can check the docs.
  • API_KEY (optional): Your email provider's authentication key.

More details are available in the Running the code wiki section.

Usage

Running the code in debug mode won't send any emails and will instead output the generated HTML in the console.

cargo run

It is recommended to try this out first and make sure that all your feeds and config variables are correctly set up.

Running the project in release mode will send the emails

./target/release/Rss2email
# or
cargo run --release

Contributing

Thanks for considering contributing!

Read this.

Thanks to all Contributors!

Dependencies

~11–26MB
~393K SLoC