Mercurial > masqmail

comparison man/masqmail.aliases.5 @ 387:a408411ff8df

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added a glob-pattern aliasing facility. One use-case is virtual hosting another catch-all maildrops, but you may use it as a more flexible aliasing mechanism as well.
author markus schnalke <meillo@marmaro.de>
date Sat, 18 Feb 2012 12:35:12 +0100
parents 35c5239ebcc1
children 34c919a8d74e
comparison
equal deleted inserted replaced
386:13c9e0969054 387:a408411ff8df
5 5
6 6
7 .SH DESCRIPTION 7 .SH DESCRIPTION
8 8
9 This man page describes the format of the masqmail alias file. 9 This man page describes the format of the masqmail alias file.
10 Its usual location is \fI/etc/aliases\fR. 10 It's usual location is \fI/etc/aliases\fR.
11
12 There exists also a variant of this format for glob patterns.
13 It's used with the \fIglobalias_file\fP config option.
14
15 The difference between the two formats are only on the left-hand side.
16 A normal alias file has a local_part there that gets string-compared
17 against the local part;
18 whereas a glob alias file has a glob pattern that is matched against
19 the whole address. The right-hand side of the two aliasing kinds
20 has the same format.
11 21
12 22
13 .SH FILE FORMAT 23 .SH FILE FORMAT
14 24
15 The alias file consists of lines of the form: 25 Normal alias files consist of lines of the form:
26
27 .RS
16 local_part: item1, item2, ... 28 local_part: item1, item2, ...
29 .RE
30
31 Glob-pattern alias files consist of lines of the form:
32
33 .RS
34 glob_pattern: item1, item2, ...
35 .RE
36
17 Items can be surrounded by double quotes `"'. 37 Items can be surrounded by double quotes `"'.
18 If within the quotes other quotes are needed for an address they can be 38 If within the quotes other quotes are needed for an address they can be
19 escaped with a leading backslash `\\'. 39 escaped with a leading backslash `\\'.
20 40
21 A leading backslash `\\' indicates that this address shall not be further expanded. 41 A leading backslash `\\' indicates that this address shall not be
42 further expanded.
22 43
23 A leading pipe symbol `|' indicates that the item shall be treated as a pipe command. 44 A leading pipe symbol `|' indicates that the item shall be treated as a
24 The content of the message will then be sent to the standard input of the command. 45 pipe command.
46 The content of the message will then be sent to the standard input of the
47 command.
25 The command will run under the user id and group id masqmail is running as. 48 The command will run under the user id and group id masqmail is running as.
26 If quotes are needed, the pipe symbol must appear within the quotes. 49 If quotes are needed, the pipe symbol must appear within the quotes.
27 50
28 Loops will be detected, the offending address will be ignored. 51 Loops will be detected, the offending address will be ignored.
29 52
30 Aliases will be expanded at delivery time. 53 Aliases will be expanded at delivery time.
31 This means that if there is a message still in the queue and you change 54 This means that if there is a message still in the queue and you change
32 any alias which matches one of the recipient addresses, 55 any alias which matches one of the recipient addresses,
33 the change will have effect next time a delivery is attemped. 56 the change will have effect next time a delivery is attemped.
34 57
35 There is no need to restart masqmail or run any command when the alias file has been changed. 58 There is no need to restart masqmail or run any command when the alias
59 file has been changed. (`masqmail -bi' is a no-op.)
36 60
37 61
38 .SH EXAMPLE 62 .SH EXAMPLE
39 63
64 A normal alias file:
65
66 .RS
40 .nf 67 .nf
41 # postmaster is required by RFC 2821 68 # postmaster is required by RFC 2821
42 postmaster: root 69 postmaster: root
43 70
44 # forward abuse mail to another address 71 # forward abuse mail to another address
48 root: \\root, meillo 75 root: \\root, meillo
49 76
50 # pass mail to a script 77 # pass mail to a script
51 foo: |/usr/bin/foo 78 foo: |/usr/bin/foo
52 .fi 79 .fi
80 .RE
81
82
83 A glob-pattern alias file:
84
85 .RS
86 .nf
87 # the postmaster for any domain on this host
88 postmaster@*: ken
89
90 # split virtual domains
91 info@foo.example.org: doug
92 info@bar.example.org: rob
93
94 # the order of entries is important
95 # this must be before the catch-all line
96 list\-*@example.org: |/path/to/some/script
97
98 # catch-all address forwarded to extern
99 *@example.org: brian@other.host.net
100 .fi
101 .RE
53 102
54 103
55 .SH AUTHOR 104 .SH AUTHOR
56 105
57 Masqmail was written by Oliver Kurth. 106 Masqmail was written by Oliver Kurth.
58 It is now maintained by Markus Schnalke <meillo@marmaro.de>. 107 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
59 108
60 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR. 109 You will find the newest version of masqmail at
61 There is also a mailing list, you will find information about it at masqmail's main site. 110 \fBhttp://marmaro.de/prog/masqmail/\fR.
111 There is also a mailing list, you will find information about
112 it at masqmail's main site.
62 113
63 114
64 .SH BUGS 115 .SH BUGS
65 116
66 Please report bugs to the mailing list. 117 Please report bugs to the mailing list.