3 umpf \- universal mail processing filter
6 [-c config_file] [-m default_mailbox]
10 Umpf is a program that reads an e-mail from stdin and according to the config
11 file decides, what to do with it. It is possible to forward the e-mail,
12 filter it through external program and, of course, deliver it to the local
13 mailbox. IMAP support is planned, but not ready yet.
17 Set an alternative location of the config file.
20 Set an alternative location of the default mailbox.
22 The program reads a config file (default location is
25 to the rules provided it decides, what to do with it. If no rule is matched,
26 or some action fails, or the config file cannot be parsed, e-mail is
27 delivered to the default mailbox (default location is
29 , program needs setgid to be able to use it).
31 Variables can be specified in the config file. Their identifiers must start
34 , variables have three types that are distinguisghed according to the case of
35 the identifiers. Upper case identifiers are reserved for automatic variables
36 like message size, it is possible to modify them but it is not encouraged.
37 Variables with identifiers starting with an upper-case letter but mixed case
38 otherwise correspond to values of e-mail headers, assigning to them will
39 change the headers. Variables with identifiers starting with a lower case
40 letter are intended for general use. Otherwise, variable identifiers are
41 case-insensitive, ie. $abc refers to the same variable as $aBc, but not the
42 same as $Abc and all of these variables differ from $ABC.
43 .SS AUTOMATIC VARIABLES
44 Config file recognizes these automatic variables:
47 refers to the length of the e-mail, including headers
50 refers to the exit code of last external program executed (actions filter or
51 pipe can be used to do it)
54 refers to the output of last external program executed by action pipe
56 A command is either an action specification or an assignment. All the
57 commands must end with semicolon. Commands can be grouped in blocks bounded by
60 Assignment is specified in a following way:
62 .B "Lvalue = Rvalue ;"
64 Lvalue is a variable identifier. Rvalue can be variable, a constant (constant
65 must be given in double quotes) or an expression consisting of variables,
66 constants and binary operations
78 stands for string contatenations, the rest of them are arithmetic operations.
79 Doing arithmetic operations makes sense only on integers. Precedence of the
80 operations can be specified using parentheses.
82 Actions are specified with an arrow operator.
85 means "deliver the e-mail to the default mailbox and exit".
88 means "deliver the e-mail the mailbox specified behind arrow and exit"
90 .B "-> pipe expression ;"
91 means "pipe the e-mail to the external program specified behind pipe
92 keyword". Output of the program is stored in
94 variable, its exit code is stored in
98 .B "-> filter expression"
99 means "pipe the e-mail to the external program and replace it with output of the program". All the header variables,
106 means just "discard the email and exit".
108 .B -> mail expression ;
109 means "forward the e-mail to the address specifed behind the mail keyword and exit"
111 If action fails, the e-mail is delivered to the default mailbox.
113 Some of the actions (delivery or forwarding an e-mail) can have keyword copy
114 in front of the arrow, ie.
116 .B "copy -> $mailbox;"
118 When copy is specified, the program does not exit after doing an action but
119 continues reading the rules. It also does not deliver to the default mailbox if
122 Conditional execution of commands can be specified in a following way:
124 .B "if (condition) { ... }"
126 .B "if (condtion) { ... } else { ... }"
128 .B "if (condition) { ... } else if { ... } [ else { ... } ]"
130 where the condition can be a constant, a variable or an expression consisting
131 of following operations:
134 is binary boolean and
140 is binary boolean xor
145 A variable or a constant has a boolean value 0, if its value is either "" or
148 Expressions can be compared using following binary relations.
153 means "matches" (left operand should be string, right one can be a perl compatible regular expression)
156 means "does not match"
158 Integer comparisons (does not make sense on strings):
164 means "is not equal to"
167 means "is lesser than"
170 means "is greater than"
173 means "is lesser or equal than"
176 means "is greater or equal than"
178 Parentheses can be used to specify a precedence. Boolean operations have greater priority than relation operations.
180 All the text behind a hash character up to the end of the line is ignored.
196 Anicka <anicka@anicka.net>
198 Current version of the program can be downloaded at
199 .B http://www.anicka.net/umpf
201 The program can be used according to the terms of GPL, version 2.