The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
rssdrop-0.1
River stage zero No dependents
/ rssdrop

NAME

rssdrop - deliver rss feeds to Maildirs

SYNOPSIS

rssdrop [-a feed url] | [-d feed] | [feed1 feed2 ...]

EXAMPLES

Initialize rssdrop:

  $ rssdrop --mailfolder path/to/mailfolder

Subscribe to a new feed:

  $ rssdrop -a acme-widgets http://acme.com/widgets.rss

Fetch items in your new feed:

  $ rssdrop acme-widgets

Unsubscribe:

  $ rssdrop -d acme-widgets

Fetch all new items in all feeds:

  $ rssdrop

DESCRIPTION

rssdrop is a simple RSS -> mail gateway. It delivers new RSS feed items directly to a local Maildir folder of your choice. You can use your favorite mail client to read them.

rssdrop knows the basic structure of RSS 1.0 and 2.0 feeds, enough to deliver the raw item xml as the body of the message, or fetch the fulltext from the item link. Use fulltext = 1 in your feed config for that.

OPTIONS

--add feed1 url1 feed2 url2 ...

Add named feeds to your config. Checks that the url has valid rss.

--delete feed1 feed2 ...

Remove named feeds from your config.

--prefix path/to/rssdrop/dir

Controls where rssdrop will save its config. Fetched feeds and items are also stored here.

By default, rssdrop uses the $RSSDROP_PREFIX variable. If not set, it falls back to $HOME/.rssdrop. This directory will be created and populated with an initial config file if they don't exist.

--mailfolder path/to/mailfolder

Sets the mailfolder rssdrop should deliver new items to. Each feed has its own Maildir beneath $mailfolder. rssdrop will create a Maildir for a feed if one doesn't exist.

This option is required and initially has no default. After one-time setup, however, rssdrop saves your $mailfolder setting in the global section of the config file. If you're happy with this setting, there's no need to specify --mailfolder after that.

--verbose

Turn on extra logging messages. By default, rssdrop is quiet.

--help

Display usage information.

TODO

  • output crontab entries, choosing intervals based rss update info

  • honor fulltext = 1 config feed option

  • add a --cleanup option to remove old / unused feed state

  • try to extract a sender address from item content / rss

CONFIGURATION

The rssdrop config file (by default, ~/.rssdrop/config) uses a simple ini-style format, with a global config section followed by feed-specific config. Here's a sample:

  mailfolder = /home/jdoe/var/mail

  [freebsd-sa]
  url = http://www.freebsd.org/security/advisories.rdf

  [craigslist-nyc-cheap-apts]
  fulltext = 1
  url = http://newyork.craigslist.org/search/aap?query=&minAsk=1000&maxAsk=2000&bedrooms=&format=rss

BUGS

This is an experimental release. Please report bugs on CPAN.

AUTHOR

Alan Grow <agrow+nospam@thegotonerd.com>

COPYRIGHT

Copyright (C) 2007 by Alan Grow

This application is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.3 or, at your option, any later version of Perl 5 you may have available.