Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Convert feeds to maildirs

Project description

Read RSS/Atom feeds in your favourite, maildir-compatible email client.


  • Python 3.2+
  • feedparser
  • python-dateutil


Just run feed2maildir, which should be placed in your $PATH by You will need a JSON configuration file at $HOME/.f2mrc that looks like this:

    "db": "~/.f2mdb",
    "maildir": "~/mail/feeds",
    "feeds": {
        "Coding Horror": "",
        "Commit Strip": "",
        "XKCD": "",
        "What If?": "",
        "Dilbert": "",
        "BSDNow": ""

Note that the last element in a dict must not be followed by a comma, because Python’s json.loads() says so.

There are a bunch of command-line arguments to overwrite the config file:

optional arguments:
    -h, --help  show this help message and exit
    -c <file>   override the config file location (~/.f2mrc)
    -d <file>   override the database file location (~/.f2mdb)
    -m <dir>    override the maildir location (None)
    -s          strip HTML from the feeds
    -S <prog>   strip HTML from the feeds using an external program
    -l          just write the links without the update

To check for updates regularly, just toss it into cron to run once every hour or so.

Strip HTML

feed2maildir can strip the HTML tags from the feed using a built-in HTML stripper (option -s) or using an external program (option -S <prog>)

In this last case, the program must read the HTML from it standard input and return it stripped via the standard output.

The <prog> can be the name of a program or it can be a full shell command. In that case don’t forget to quote the full command.

Here is an example of using pandoc to convert HTML to Markdown

feed2maildir -S 'pandoc --from html --to markdown_strict'

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for feed2maildir, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size feed2maildir-0.4.0.macosx-10.12-x86_64.tar.gz (10.9 kB) File type Source Python version None Upload date Hashes View
Filename, size feed2maildir-0.4.0-py2.7.egg (13.6 kB) File type Egg Python version 2.7 Upload date Hashes View
Filename, size feed2maildir-0.4.0-py3.8.egg (13.7 kB) File type Egg Python version 3.8 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page