Updated man pages: Removed the notice that whatnow could be called internally.
[mmh] / docs / README-HOOKS
1 Jon Steinhart's (jon@fourwinds.com) External Program Hooks
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4 This blurb describes a changes to nmh that implement an interface
5 to external programs.  This interface is different than the limited
6 interface provided by things like the rmmproc context entry.
7
8
9 Why Did I Do This?
10 ~~~~~~~~~~~~~~~~~~
11
12 I'm working on a project (grokmail) that will get released via GPL sometime
13 soon.  This project keeps a database synchronized with the messages in the
14 mail system.  New functionality is built on top of this database.  This
15 functionality allows fast searching, and searching based on interest
16 criteria.  The latter can be used for spam filtering.
17
18 The changes to nmh allow external programs to be run whenever a message is
19 added to a folder, removed from a folder, or refiled.  The changes are
20 implemented in a general way so that it can be used for other purposes than
21 mine.
22
23 What Are The Changes?
24 ~~~~~~~~~~~~~~~~~~~~~
25
26 The changes add four new profile components:
27
28 add-hook:       This is the full pathname of a program that is invoked
29                 whenever a message is added to a folder.  The program
30                 is passed one argument which is the full pathname of the
31                 message file.  The program is executed after the message
32                 is written so that it can act upon that message.
33
34 del-hook:       This is the full pathname of a program that is invoked
35                 whenever a message is deleted from a folder.  The program
36                 is passed one argument which is the full pathname of the
37                 message file.  The program is executed before the message
38                 is written so that it can act upon that message.
39
40 ref-hook:       This is the full pathname of a program that is invoked
41                 whenever a message is refiled.  The program is passed two
42                 arguments:  the first is the full pathname of the original
43                 message file, the second is the full pathname of the final
44                 message file.  The program is executed after the message
45                 is written.
46
47 msg-hook:       This is a text message that is output if the execution of
48                 one of the external hook programs fails.  There is a built-in
49                 default message if none is specified.
50
51 The definition of refiling is a bit tricky.  The refile hook is executed if a
52 message is moved from one place to another.  So, for example, the command
53
54         refile -link
55
56 causes the add hook to be executed, not the refile hook, because a new message
57 is created, the old one isn't moved.
58
59 These changes affect the following commands:
60
61 burst:          The add hook is executed for messages burst from a digest, and
62                 for the table of contents if -inplace is specified.  The delete
63                 hook is executed for the original message if -inplace is
64                 specified.  The refile hook is executed for messages that are
65                 moved.
66
67 folder:         The refile hook is executed for -pack.
68
69 inc:            The add hook is executed when messages are incorporated.
70
71 refile:         Either the add or refile hooks are executed.
72
73 rmf:            The delete hook is executed when messages are deleted.
74
75 rmm:            The delete hook is executed when messages are deleted.
76
77 sortm:          The refile hook is executed for each message moved.  Note that
78                 a magic temporary message number of 2147483647 is used to hold
79                 messages as they are being shuffled.
80
81 rcvstore:       The add hook is executed when messages are stored.
82
83 mhstore:        The add hook is executed when messages are stored.
84
85 Did I Do This Correctly?
86 ~~~~~~~~~~~~~~~~~~~~~~~~
87
88 Well, sort of.  This all works, but I'm not really happy with it.  The issue
89 is that an examination of the nmh code shows that message handling is scattered
90 all over the place.  Although there are library routines such as folder_addmsg
91 and folder_delmsgs, they are not used consistently.  Long term, I think that it
92 would be better to make all message handling go through the same choke points.
93
94 Also, I added a function to run the external programs.  This sort of stuff is
95 also scattered around the nmh code, for example in the code to run the rmmproc.
96 Again, I'd like to make this more consistent in the long term.
97
98 What Files Did I Change?
99 ~~~~~~~~~~~~~~~~~~~~~~~~
100 uip/
101         burst.c
102         inc.c
103         refile.c
104         rmf.c
105         sortm.c
106
107 sbr/
108         folder_addmsg.c
109         folder_delmsgs.c
110         folder_pack.c
111         ext_hook.c      (new file)