Getting Started with rss2email

We highly recommend that you subscribe to the rss2email project feed so you can keep up to date with the latest version, bugfixes and features: http://feeds.feedburner.com/allthingsrss/hJBr

Instructions for Windows Users
Instructions for UNIX (Linux, Mac OS X, BSD and CentOS) Users
Customizing rss2email

Instructions for Windows Users

Requirements

Before you install rss2email, you’ll need to make sure that a few things are in place. First, is that a version of Python 2.x installed. Second, determine your outgoing email server’s address. That should be all you need.

Download

  1. Create a new folder
  2. Download the latest rss2email .ZIP file and unzip to the new folder

Configure

Copy the provided config.py.example file to config.py and fill in your outoing email server’s details. If your server requires you to login, change "AUTHREQUIRED = 0" to "AUTHREQUIRED = 1" and enter your email username and password.

Install

From the command line, change to the folder you created. Now create a new feed database to send updates to your email address:

r2e new you@yourdomain.com

Subscribe to some feeds:

r2e add http://feeds.feedburner.com/allthingsrss/hJBr

That’s the feed to be notified when there’s a new version of rss2email. Repeat this for each feed you want to subscribe to.

When you run rss2email, it emails you about every story it hasn’t seen before. But the first time you run it, that will be every story. To avoid this, you can ask rss2email not to send you any stories the first time you run it:

r2e run --no-send

Then later, you can ask it to email you new stories:

r2e run

If you get an error message “Sender domain must exist”, add a line to config.py like this:

DEFAULT_FROM = rss2email@yoursite.com

You can make the email address whatever you want, but your mail server requires that the yoursite.com part actually exists.

Automating rss2email

More than likely you will want rss2email to run automatically at a regular interval. Under Windows this is can be easily accomplished using the Windows Task Scheduler. This site has a nice tutorial on it. Just select r2e.bat as the program to run. Once you’ve created the task, double click on it in the task list and change the Run entry so that “run” comes after r2e.bat. For example, if you installed rss2email in the C:\rss2email folder, then you would change the Run entry from “C:\rss2email\r2e.bat” to “C:\rss2email\r2e.bat run”.

Your help with rss2email commands, just run r2e help or just r2e.

Now jump down to the section on customizing rss2email to your needs.

Upgrading to a new version

Simply replace all of the files from the .ZIP package to your install directory EXCEPT config.py

Instructions for UNIX/Linux Users

Requirements

Before you install rss2email, you’ll need to make sure that a few things are in place. First, is a version of Python 2.x installed. Second, is whether you have sendmail (or a compatible replacement like postfix) installed. If sendmail isn’t installed, determine your outgoing email server’s address. That should be all you need.

Download

A quick way to get rss2email going is using pre-made packages. Here are releases for Debian Linux, Ubuntu Linux and NetBSD.

If you are unable to use these packages or you want the latest and greatest version, here’s what you do:


Unarchive (probably 'tar -xzf') the rss2email .tar.gz package to [folder where you want rss2email files to live]

cd [yourfolder]

chmod +x r2e

cp config.py.example config.py

Install

Create a new feed database with your target email address:

./r2e new you@yourdomain.com

Subscribe to some feeds:

./r2e add http://feeds.feedburner.com/allthingsrss/hJBr

That’s the feed to be notified when there’s a new version of rss2email. Repeat this for each feed you want to subscribe to.

When you run rss2email, it emails you about every story it hasn’t seen before. But the first time you run it, that will be every story. To avoid this, you can ask rss2email not to send you any stories the first time you run it:

./r2e run --no-send

Then later, you can ask it to email you new stories:

./r2e run

You probably want to set things up so that this command is run repeatedly. (One good way is via a cron job.)

If you get an error message “Sender domain must exist”, add a line to config.py like this:

DEFAULT_FROM = rss2email@yoursite.com

You can make the email address whatever you want, but your mail server requires that the yoursite.com part actually exists.

Your help with rss2email commands, just run r2e help or just r2e.

Upgrading to a new version

Simply replace all of the files from the .tar.gz package to your install directory EXCEPT config.py

Customize rss2email

There are a number of options, described in full in the provided config.py.example file and at the top of rss2email.py file, to customize the way rss2email behaves. If you want to change something, edit the config.py file. If you’re not using rss2email under Windows, you’ll have to create this file if it doesn’t already exist.

For example, if you want to receive HTML mail, instead of having entries converted to plain text:

HTML_MAIL = 1

To be notified every time a post changes, instead of just when it’s first posted:

TRUST_GUID = 0

And to make the emails look as if they were sent when the item was posted:

DATE_HEADER = 1

127 Responses to “Getting Started with rss2email”

  1. Akhsurdna says:

    man a guide with pictures would be so helpfull does anyone know any site with a better tutorial cuz im new to phyton and dont understand the installation procedure.

  2. Hey I saw you have a wordpress site and decided to tell you that your RSS reader is sending a 404 i hope you can get it working

  3. Hey. Thanks for this, this is really want i’m looking for, a step by step guide in installing rss2email.

  4. Vladimir says:

    Is it possible to edit some of the files so that all links in email are opened in new window? I am asking this because i am using RSS2mail to post article on my blog, but if i put external link visitors will open new site. I want that all links sent by email are opened in new window.
    Can you help me with this?

  5. orlando says:

    thanks for theese great infos ,im not paython user and want to forward from rss to blogspot,is there is another easy way to do that?

  6. Stefano says:

    Please update the guide for new users! I’ve never used pyton and I’m really struggling installing this program (maybe also with images would be great)

    Thank you.

  7. kicalaf says:

    Thanks, after shutting down the google reader, I’ve been looking for such oportunity, because it’s the simplest way to get the rss feeds, but I am the newbie to python and really don’t know how to install this script. :(

    Is there any way to make the guide with image preview (step by step) what to do to make this properly running? For windows users I mean.

    Thanks in advance :D

  8. sriram says:

    hey bro.. Gud software to update rss bro…
    Is there anyway to make feeds from the forum software to work with this..
    ex:community.mybb.com
    I included its rss, bt it didn work.. :(

  9. danet says:

    Hello,

    I installed r2e and tried to use it but i’m a beginner with python and rss feeds so it’s quite hard for me.
    I’m in a research place protected with a firewall and that seems to make difficult all my attempts to use r2e.
    I tried to get some simple URLs I know, and I only get this kind of message:

    I: Processing [1] “http://rss.[...]/index.rss”
    W: error 404 [1] http://rss.…]/indx.rss”

    Is there a problem with my config?
    Thank you

  10. Error 404 is “page not found”, the same as you would get in a browser. Make sure that the feed URLs also work in the browser from your location.

  11. Vincent says:

    Wow, this is exactly what I was looking for! Two suggestions:
    1) Add a flattr button on your site :-)
    2) I want to “cluster” the news like “all new posts within one mail” or “all new posts by one site in one mail” – Is there a chance of getting this feature? :-)

    Anyway – thank you very much!

  12. [...] instead, we are going to use a free, open-source tool called RSS2Email. It is available for users of both Windows and Unix [...]

  13. tarpan says:

    If you could tell us WHERE we should save the config.py under Linux (Ubuntu in my case), you could save us a lot of headache.

  14. awilian says:

    perfect script! thank you !!

  15. Julian says:

    @tarpan:
    FILES
    ~/.rss2email/feeds.dat
    The database of feeds. Use r2e to add, remove, or modify feeds, do not edit it directly.

    ~/.rss2email/config.py
    If this file exists, it it read to configure the program.

    @Author
    You might wanna correct this: “If this file exists, it it read to configure the program.”

    The part with “it it”

  16. Austin Kimbrough says:

    C:\rss2email-2.70>r2e run
    W: looks like HTML [1] http://pipes.yahoo.com/pipes/pipe.run?_id
    E: error in [2] “7639d7857574ee6f8677d59da4dded83″ feed (:2:0: syntax e
    rror)
    W: looks like HTML [3] http://pipes.yahoo.com/pipes/pipe.run?_id
    E: error in [4] “7639d7857574ee6f8677d59da4dded83″ feed (:2:0: syntax e
    rror)

    Any thoughts?

  17. Delete the feeds with the errors and re-add the full URLs with quotes around, as described below.

  18. david says:

    Congratulations for these wonderfoul application.

    I would like to know if there is an option to can send only one mail of all the changes of all the rss that I added in r2e.

    The problem that I have is that if I have a log of feeds I exceed the gmail quota.

    Many thanks and sorry for my english!

  19. David,

    I call that “digest mode” which is something rss2email does not support. There is another version for Python 3 that DOES. Perhaps try that one?

  20. david says:

    Many thanks lindsey

    Where can i download these versión?

  21. Matthew says:

    Thanks for the guide and all your dev work Lindsey, I always feel much better using software if it’s open source!

  22. Before you install rss2email, you’ll need to make sure that a few things are in place. First, is that a version of Python 2.x installed. Second, determine your outgoing email server’s address. That should be all you need.

  23. robert says:

    I’m newbie for Python programmer, I have a problem with feed email from mail server. I will try to install the rss2email.

    Thank you for Python script!

  24. Benny says:

    Is it possible to change to use pushbullet https://www.pushbullet.com/api

    Would be cool to get updates on iphone notifications rather than email.

  25. Emilien says:

    In Windows, should you get the following error message:
    ‘python’ is not recognized as an internal or external command, operable program or batch file.

    you’ll need to add the Python executable path to your Window’s PATH variable.
    http://stackoverflow.com/questions/7054424/python-not-recognised-as-a-command#answer-7054429

  26. vBulletin says:

    Delete the feeds with the errors and re-add the full URLs with quotes around, as described below. http://www.tr-vbulletin.com/forum.php

Leave a Reply