imm: Execute arbitrary actions for each unread element of RSS/Atom feeds

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

The 'description' field should be longer than the 'synopsis' field. It's useful to provide an informative 'description' to allow Haskell programmers who have never heard about your package to understand the purpose of your package. The 'description' field content is typically shown by tooling (e.g. 'cabal info', Haddock, Hackage) below the 'synopsis' which serves as a headline. Please refer to <https://www.haskell.org/cabal/users-guide/developing-packages.html#package-properties> for more details.

Cf README file

[Skip to Readme]

Properties

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, 1.4.0.0, 1.5.0.0, 1.5.0.0, 1.6.0.0, 1.6.1.0, 1.7.0.0, 1.8.0.0, 1.9.0.0, 1.10.0.0, 2.0.0.0, 2.1.0.0, 2.1.1.0, 2.1.2.0, 2.1.3.0
Change log	None available
Dependencies	aeson, atom-conduit (>=0.6), base (>=4 && <5), base-noprelude (>=4 && <5), blaze-html, blaze-markup, bytestring, case-insensitive, conduit, connection, containers, directory (>=1.2.3.0), dyre, fast-logger, filepath, hashable, HaskellNet, HaskellNet-SSL (>=0.3.3.0), http-client (>=0.4.30), http-client-tls, http-types, imm, microlens, mime-mail, monad-time, monoid-subclasses, mtl, network, opml-conduit (>=0.7), optparse-applicative, prettyprinter, prettyprinter-ansi-terminal, refined, relude, rss-conduit (>=0.4.1), safe-exceptions, stm, streaming-bytestring, streaming-with, streamly, text, time, timerep (>=2.0.0.0), tls, transformers-base, uri-bytestring, xml, xml-conduit (>=1.5), xml-types [details]
License	LicenseRef-PublicDomain
Author	kamaradclimber, koral
Maintainer	koral <koral@mailoo.org>
Category	Web
Home page	https://github.com/k0ral/imm
Source repo	head: git clone git://github.com/k0ral/imm.git
Uploaded	by koral at 2019-02-17T09:30:17Z

Modules

[Index] [Quick Jump]

Downloads

imm-1.5.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

koral

For package maintainers and hackage trustees

edit package information

Readme for imm-1.5.0.0

[back to package description]

imm

imm is a tool to execute arbitrary actions for each new element from RSS/Atom feeds (e.g. sending a mail, or writing a file).

imm is written and configured in Haskell.

Technical documentation is available at hackage.

To get started, please consult documentation of Imm.Boot module.

Example use cases

Online feed reader

For the sake of I-want-the-mutt-of-feed-readers zealots, it is possible to turn any mail reader into a feed reader, by having imm send an e-mail with unread elements to an arbitrary address. You can then browse your feeds through your favourite mail reader, and leverage any mail-related tool on your feeds. Bonus points if your mail reader is online as you can now access your feeds from any computer connected to the Internet.

Check out Imm.Hooks.SendMail module.

Offline read-it-later

imm is able to store a local copy of unread elements, to read them later while offline for example. External links won't work offline though.

Check out Imm.Hooks.WriteFile module.

Example usage

Subscribe to a feed:
```
imm subscribe http://your.feed.org
```
Import feeds from an OPML file:
```
cat feeds.opml | imm import
```
List subscribed feeds:
```
imm show
```
Unsubscribe from a feed:
```
imm unsubscribe http://your.feed.org
```
Check for new elements without executing any action:
```
imm check
```
Execute configured actions for each new element from subscribed feeds:
```
imm run
```