masqmail

annotate man/masqmail.aliases.5 @ 405:0dd84c8f2524

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