aboutsummaryrefslogtreecommitdiff
path: root/contrib/notmuch-deliver/README.mkd
blob: 06268bd8400e24abc8065dcd4282f66f018c1234 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
## About
`notmuch-deliver` is a [maildir](http://cr.yp.to/proto/maildir.html) delivery
tool.

## Overview
`notmuch-deliver` is a [maildir](http://cr.yp.to/proto/maildir.html) delivery
tool for [notmuch](http://notmuchmail.org) mail indexer. It reads from standard
input, delivers the mail to the specified maildir and adds it to the notmuch
database. This is meant as a convenient alternative to running `notmuch new`
after mail delivery.

## Usage
Here's a simple example for [maildrop](http://www.courier-mta.org/maildrop/):

    # Deliver local mail to $MAILDIR/.Local and add local tag.
    if (/^From: root/:h)
    {
      to "|notmuch-deliver -f -t local Local"
    }

    # Deliver lkml mail to $MAILDIR/.Lkml, add lkml tag and remove inbox tag.
    if (/^List-Id: linux-kernel@vger.kernel.org/:h)
    {
      to "|notmuch-deliver -f -t lkml -r inbox Lkml"
    }

    # Deliver the rest to $MAILDIR, adding personal tag
    to "|notmuch-deliver -t personal"

## Requirements
- [notmuch](http://notmuchmail.org) shared library
- [GLib](http://library.gnome.org/devel/glib/)-2.16 or newer

## Contribute
Clone [git://github.com/alip/notmuch-deliver.git](git://github.com/alip/notmuch-deliver.git).  
Format patches are preferred. Either send a mail to me or poke me on IRC.  
My personal e-mail address is [alip@exherbo.org](mailto:alip@exherbo.org).  
I'm available on IRC as `alip` on [Freenode](http://freenode.net) and [OFTC](http://www.oftc.net).

## License
You may redistribute this under the same terms as notmuch itself.

<!-- vim: set ft=mkd spell spelllang=en sw=4 sts=4 et : -->