Rss2email

From ArchWiki
Revision as of 04:27, 8 March 2010 by Trey (Talk | contribs) (Removed stub template)

Jump to: navigation, search
Summary help replacing me
An overview of the RSS feed reader program that lets users read RSS feeds from their inboxes.

rss2email is a free tool for retrieving content from RSS feeds and mailing it. It is useful for those who don't want yet another program with which to keep up and for people who have a system for e-mail management that they would like to apply to their RSS feeds as well. People with lots of e-mail often have highly customized systems that let them process their mail efficiently; rss2email allows them to easily apply this system to their feeds as well.

Installation

rss2email is available from the AUR here. See the AUR_User_Guidelines for help installing the package. Users with yaourt installed on their systems may also run:

$ yaourt -S rss2email

rss2email requires python, python-feedparser, and python-html2text to run.

Adding Feeds

First, tell rss2email where it should send feeds by running the command:

$ r2e new user@example.com

Next, subscribe to an RSS feed. For example, to subscribe to the Arch Linux package updates feed, run:

$ r2e add http://www.archlinux.org/feeds/packages/ e-mail address

Note that an e-mail address only has to be given if the feed is to be delivered to an address other than the default one; otherwise, leaving off the e-mail address is acceptable.

After a new feed is added, rss2email will e-mail every post it hasn't previously e-mailed. The first time it is run, therefore, it will e-mail every post. To avoid this behavior, after adding a new feed, run:

$ r2e run --no-send

Getting RSS Feeds

To get new stories, execute the command:

$ r2e run

To automate this process and have rss2email check for new feeds every 30 minutes, users should add the following to their Template:Codeline by running the command Template:Codeline and appending to the file:

00,30 * * * * r2e run

Managing rss2email

To view feeds previously added to rss2email, run:

r2e list

This will output a numbered list of feeds. To delete a feed, run:

r2e delete number

where number is the number of the feed to be deleted.

To change the default e-mail address, run:

r2e email new_address@example.net

Advanced Configuration

The following configuration changes should be made in Template:Codeline, which should be located at Template:Codeline.

To have RSS entries sent as HTML e-mails instead of as plain text, set:

HTML_MAIL = 1

To receive new e-mails when RSS posts are updated, set:

TRUST_GUID = 0

To set the date header of e-mails to when the RSS post was written, rather than when the e-mail is actually sent, set:

DATE_HEADER = 1

To fix the error message "sender domain must exist" or to change the address from which e-mails are sent, set:

DEFAULT_FROM = user@example.com

To force all feeds to use this address, even if they have their own address set, use:

FORCE_FROM = 1

To have rss2email automatically wrap long lines, set:

BODY_WIDTH = 72

Where 72 is the number of characters after which rss2email should start a new line.

To send mail using an SMTP server rather than the local machine, use:

SMTP_SEND = 1
SMTP_SERVER = "smtp.example.com:25"

If the SMTP server requires authentication, set:

AUTHREQUIRED = 1
SMTP_USER = "user@example.com"
SMTP_PASS = "password"

More Information

More information on rss2email can be found on its official getting started page as well as in this linux.com article.