quickstart.rst

Quick Start

The steps to get up and running are:

• install the afew package
• create the config files
• add a notmuch post-new hook that calls afew

Install

The following commands will get you going on Debian/Ubuntu systems:

$ sudo aptitude install notmuch python-notmuch dbacl
$ git clone git://github.com/teythoon/afew.git
$ cd afew
$ python setup.py install --prefix=~/.local

Ensure that ~/.local/bin is in your path. One way is to add the following to your ~/.bashrc:

if [ -d ~/.local/bin ]; then
    PATH=$PATH:~/.local/bin
fi

See :doc:`installation` for a more detailed guide.

Initial Config

Make sure that ~/.notmuch-config reads:

[new]
tags=new

Put a list of filters into ~/.config/afew/config:

# This is the default filter chain
[SpamFilter]
[KillThreadsFilter]
[ListMailsFilter]
[ArchiveSentMailsFilter]
[InboxFilter]

And create a post-new hook for notmuch to call afew:

$ notmuchdir=path/to/maildir/.notmuch
$ mkdir -p "$notmuchdir/hooks"
$ printf > "$notmuchdir/hooks/post-new" '#!/usr/bin/env sh\n$HOME/.local/bin/afew --tag --new\n'
$ chmod u+x "$notmuchdir/hooks/post-new"

Next Steps

You can:

• add extra :doc:`filters` for more custom filtering
• make use of the :doc:`move_mode` to move your email between folders
• run afew against all your old mail by running afew --tag --all
• start :doc:`extending` afew