unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob f07e4dabf21ab5dc608eb989d3e4c94218391fbe 1927 bytes (raw)
name: doc/man5/notmuch-hooks.rst 	 # note: path name is non-authoritative(*)

 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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
=============
notmuch-hooks
=============

SYNOPSIS
========

$DATABASEDIR/.notmuch/hooks/*

DESCRIPTION
===========

Hooks are scripts (or arbitrary executables or symlinks to such) that
notmuch invokes before and after certain actions. These scripts reside
in the .notmuch/hooks directory within the database directory and must
have executable permissions.

The currently available hooks are described below.

    **pre-new**
        This hook is invoked by the **new** command before scanning or
        importing new messages into the database. If this hook exits
        with a non-zero status, notmuch will abort further processing of
        the **new** command.

        Typically this hook is used for fetching or delivering new mail
        to be imported into the database.

    **post-new**
        This hook is invoked by the **new** command after new messages
        have been imported into the database and initial tags have been
        applied. The hook will not be run if there have been any errors
        during the scan or import.

        Typically this hook is used to perform additional query-based
        tagging on the imported messages.

    **post-insert**

        This hook is invoked by the **insert** command after the
        message has been delivered, added to the database, and initial
        tags have been applied. The hook will not be run if there have
        been any errors during the message delivery; what is regarded
        as successful delivery depends on the ``--keep`` option.

        Typically this hook is used to perform additional query-based
        tagging on the delivered messages.

SEE ALSO
========

**notmuch(1)**,
**notmuch-config(1)**,
**notmuch-count(1)**,
**notmuch-dump(1)**,
**notmuch-insert(1)**,
**notmuch-new(1)**,
**notmuch-reply(1)**,
**notmuch-restore(1)**,
**notmuch-search(1)**,
**notmuch-search-terms(7)**,
**notmuch-show(1)**,
**notmuch-tag(1)**

debug log:

solving f07e4dab ...
found f07e4dab in https://yhetil.org/notmuch.git/

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).