imm: Retrieve RSS/Atom feeds and write one mail per new item in a maildir.

[ library, program, public-domain, web ] [ Propose Tags ]

Cf README


[Skip to Readme]
Versions 0.1.0.0, 0.1.1.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.1.0, 0.5.0.0, 0.5.0.1, 0.5.1.0, 0.6.0.0, 0.6.0.1, 0.6.0.2, 0.6.0.3, 1.0.0.0, 1.0.1.0, 1.1.0.0, 1.2.0.0, 1.2.1.0, 1.3.0.0
Dependencies async, base (==4.*), bytestring, case-insensitive, cond, data-default, directory, dyre, feed, filepath, hslogger, http-conduit (>=1.9.0), http-types, imm, lens, mime-mail, monad-control, mtl, network (<2.6), old-locale, opml, random, resourcet, text, text-icu, time, timerep (>=1.0.3), tls, transformers, transformers-base, utf8-string, xdg-basedir, xml [details]
License LicenseRef-OtherLicense
Author kamaradclimber, koral
Maintainer koral att mailoo dott org
Revised Revision 1 made by koral at Wed Aug 8 09:13:33 UTC 2018
Category Web
Source repo head: hg clone https://bitbucket.org/k0ral/imm
Uploaded by koral at Wed Jun 12 21:05:12 UTC 2013
Distributions NixOS:1.3.0.0
Executables imm
Downloads 6612 total (41 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for imm-0.6.0.1

[back to package description]
=========
About imm
=========

In a nutshell
-------------

**Technically**, *imm* is a little tool that retrieves a list of RSS/Atom feeds and fills a maildir with new items.

**Functionally**, *imm* makes it possible to use mail readers for feeds, for the sake of *I-want-the-mutt-of-feed-readers* zealots.

*imm* is written and configured in *Haskell*.

Informations about versions, dependencies, source repositories and contacts can be found in hackage_.


Need & purpose
--------------

Following numerous RSS/Atom feeds needs organization and aggregation.
Such needs are usually met by feed readers.
Although there are a lot of those, some people still feel unsatisfied with the existing implementations.

The expected features of a feed reader could be defined as follows:

- it retrieves items with the following attributes: an author, a date/time, a (possibly enriched) body;
- items can be sorted, categorized, marked as read/unread, tagged, shared/forwarded;
- items must be available from anywhere on the internet.

Luckily, there's already a widespread solution that provides such features: mail readers.
Considering that, *imm* aims at projecting the RSS/Atom paradigm onto the mail one; this way, all the existing tools that work on mails can be leveraged to work on RSS/Atom feeds as well, no wheel reinventing.


Function
--------

*imm* does only one thing and does it well: it downloads an RSS/Atom feeds list, and for each new item it writes a file in a local maildir. How and where to write mail files is setup in *imm*'s configuration file.

No *SMTP* sending, no *IMAP* serving, no aggregating: those should be performed by external tools.


Example usage
-------------

It is possible to setup a Google Reader-like on a server using the following steps:

- schedule *imm* to check feeds regularly and write new items into a local maildir;
- setup an IMAP server to publish the aforementioned maildir;
- setup a webmail, bound to the IMAP server above, to read feeds from any computer connected to the internet.


Getting started
---------------

To get started, please fill the configuration file at ``~/.config/imm/imm.hs`` with your feeds list and settings. An example configuration file is provided with the package. Configuring *imm* requires basic knowledge of *Haskell* language.


.. _hackage: http://hackage.haskell.org/package/imm