annotate man/masqmail.conf.5 @ 57:ed34413652fc

moved man pages from docs/ to man/
author meillo@marmaro.de
date Sat, 29 May 2010 22:07:07 +0200
parents docs/masqmail.conf.5@5e527abc1fc2
children 10d00e3235f2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42
03817f849106 decided to release the next version as 0.2.22 (not as 0.3.0)
meillo@marmaro.de
parents: 40
diff changeset
1 .TH masqmail.conf 5 2010-05-07 masqmail-0.2.22 "File Formats"
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
2
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
3 .SH NAME
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
4 masqmail.conf \- masqmail configuration file
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
5
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
6
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
7 .SH DESCRIPTION
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
8
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
9 This man page describes the syntax of the main configuration file of masqmail.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
10 Its usual location is \fI/etc/masqmail/masqmail.conf\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
11
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
12 The configuration consists of lines of the form
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
13
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
14 \fBval\fR = \fIexpression\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
15
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
16 Where \fBval\fR is a variable name and \fIexpression\fR a string,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
17 which can be quoted with double quotes `"'.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
18 If the expression is on multiple lines or contains characters other than letters,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
19 digits or the characters `.', `-', `_', `/', it must be quoted.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
20 You can use quotes inside quotes by escaping them with a backslash.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
21
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
22 Each val has a type, which can be boolean, numeric, string or list.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
23 A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
24 List items are separated with semicolons `;'.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
25 For some values patterns (like `*',`?') can be used.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
26 The spaces before and after the equal sign `=' are optional.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
27
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
29 \fBonline_routes\fR, and \fBonline_gets\fR) accept files.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
30 These will be recognized by a leading slash `/'.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
31 The contents of these files will be included at the position of the file name,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
32 there can be items or other files before and after the file entry.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
33 The format of the files is different though, within these files each entry is on another line.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
34 (And not separated by semicolons).
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
35 This makes it easy to include large lists which are common in different configuration files,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
36 so they do not have to appear in every configuration file.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
37
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
38 Blank lines and lines starting with a hash `#' are ignored.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
39
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
40
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
41 .SH OPTIONS
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
42
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
43 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
44 \fBrun_as_user = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
45
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
46 If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
47 This is for debugging purposes only.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
48 If the user is not root, masqmail will not be able to listen on a port < 1024
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
49 and will not be able to deliver local mail to others than the user.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
50
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
51 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
52 \fBuse_syslog = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
53
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
54 If this is set, masqmail uses syslogd for logging.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
55 It uses facility MAIL.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
56 You still have to set \fBlog_dir\fR for debug files.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
57
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
58 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
59 \fBdebug_level = \fIn\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
60
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
61 Set the debug level.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
62 Valid values are 0 to 6, increasing it further makes no difference.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
63 Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
64
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
65 .TP
44
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
66 \fBlog_dir = \fIfile\fR
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
67
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
68 The directory where log are stored, if syslog is not used.
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
69 Debug files are stored in this directory anyways.
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
70 \fI/var/log/masqmail\fR is a common value.
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
71 \fIfile\fR must be an absolute path.
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
72
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
73 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
74 \fBmail_dir = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
75
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
76 The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
44
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
77 \fIfile\fR must be an absolute path.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
78
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
79 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
80 \fBspool_dir = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
81
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
82 The directory where masqmail stores its spool files (and later also other stuff).
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
83 It must have a subdirectory \fIinput\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
84 Masqmail needs read and write permissions for this directory.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
85 I suggest to use \fI/var/spool/masqmail\fR.
44
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
86 \fIfile\fR must be an absolute path.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
87
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
88 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
89 \fBhost_name = \fIstring\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
90
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
91 This is used in different places: Masqmail identifies itself in the greeting banner
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
92 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
93 it is used in the Received: header and to qualify the sender of a locally originating message.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
94
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
95 If the string begins with a slash `/', it it assumed that it is a filename,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
96 and the first line of this file will be used.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
97 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
98
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
99 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
100
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
101 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
102 \fBremote_port = \fIn\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
103
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
104 The remote port number to be used. This defaults to port 25.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
105
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
106 This option is deprecated.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
107 Use \fBhost_name\fR in the route configuration instead.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
108 See \fBmasqmail.route(5)\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
109
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
110 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
111 \fBlocal_hosts = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
112
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
113 A semicolon `;' separated list of hostnames which are considered local.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
114 Normally you set it to "localhost;foo;foo.bar.com" if your host has the
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
115 fully qualified domain name `foo.bar.com'.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
116
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
117 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
118 \fBlocal_nets = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
119
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
120 A semicolon `;' separated list of hostnames which are on the `local' net.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
121 Delivery to these hosts is attempted immediately.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
122 You can use patterns with `*', e.g. "*.bar.com".
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
123
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
124 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
125 \fBlocal_addresses = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
126
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
127 A semicolon `;' separated list of fully qualified email-addresses which are
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
128 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
129
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
130 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
131 But there are other persons @yourdomain which are NOT local.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
132 So you can not put yourdomain to the list of local_hosts.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
133 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
134
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
135 local_addresses = "person1@yourdomain;person2@yourdomain"
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
136
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
137 to your masqmail.conf.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
138
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
139 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
140 \fBnot_local_addresses = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
141
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
142 A semicolon `;' separated list of fully qualified email-addresses which are
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
143 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
144
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
145 This is the opposite of the previous case.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
146 The majority of addresses of a specific domain are local.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
147 But some users are not.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
148 With this option you can easily exclude these users.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
149
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
150 Example:
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
151
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
152 local_hosts = "localhost;myhost;mydomain.net"
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
153
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
154 not_local_addresses = "eric@mydomain.net"
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
155
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
156 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
157 \fBlisten_addresses = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
158
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
159 A semicolon `;' separated list of interfaces on which connections will be accepted.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
160 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
161 If this is left out, port 25 will be used.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
162
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
163 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
164
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
165 Note that the names are resolved to IP addreses.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
166 If your host has different names which resolve to the same IP,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
167 use only one of them, otherwise you will get an error message.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
168
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
169 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
170 \fBdo_save_envelope_to = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
171
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
172 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
173 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
174
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
175 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
176 and the server supports Envelope-to: headers,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
177 and you want to make use of those with a mail filtering tool, e.g. procmail.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
178 It cannot be preserved because masqmail sets such a header by itself.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
179
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
180 Default is false.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
181
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
182 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
183 \fBdo_relay = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
184
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
185 If this is set to false, mail with a return path that is not local and a destination
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
186 that is also not local will not be accepted via smtp and a 550 reply will be given.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
187 Default is true.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
188
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
189 Note that this will not protect you from spammers using open relays,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
190 but from users unable to set their address in their mail clients.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
191
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
192 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
193 \fBdo_queue = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
194
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
195 If this is set, mail will not be delivered immediately when accepted.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
196 Same as calling masqmail with the \fB\-odq\fR option.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
197
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
198 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
199 \fBonline_routes.\fIname\fR = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
200
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
201 Replace \fIname\fR with a name to identify a connection.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
202 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
203 You will use that name to call masqmail with the \fB\-qo\fR option every time a
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
204 connection to your ISP is set up.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
205
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
206 Example: Your ISP has the name FastNet.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
207 Then you write the following line in the main configuration:
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
208
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
209 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
210
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
211 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
212 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
213 Masqmail will then read the specified file and send the mails.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
214
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
215 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
216 \fBconnect_route.\fIname\fR = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
217
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
218 Old name for \fBonline_routes\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
219
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
220 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
221 \fBlocal_net_route = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
222
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
223 This is similar to \fBonline_routes.\fIname\fR but for the local net.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
224 Recipient addresses that are in local_nets will be routed using this route configuration.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
225 Main purpose is to define a mail server with mail_host in your local network.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
226 In simple environments this can be left unset.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
227 If unset, a default route configuration will be used.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
228
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
229 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
230 \fBalias_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
231
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
232 Set this to the location of your alias file.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
233 If unset, no aliasing will be done.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
234
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
235 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
236 \fBalias_local_caseless = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
237
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
238 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
239
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
240 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
241 \fBpipe_fromline = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
242
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
243 If this is set, a from line will be prepended to the output stream whenever
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
244 a pipe command is called after an alias expansion.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
245 Default is false.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
246
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
247 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
248 \fBpipe_fromhack = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
249
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
250 If this is set, each line beginning with `From ' is replaced with `>From '
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
251 whenever a pipe command is called after an alias expansion.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
252 You probably want this if you have set \fBpipe_fromline\fR above.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
253 Default is false.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
254
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
255 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
256 \fBmbox_default = \fIstring\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
257
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
258 The default local delivery method.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
259 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
260 Default is mbox.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
261 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
262 or \fBmaildir_users\fR options (see below).
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
263
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
264 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
265 \fBmbox_users = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
266
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
267 A list of users which wish delivery to an mbox style mail folder.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
268
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
269 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
270 \fBmda_users = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
271
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
272 A list of users which wish local delivery to an mda.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
273 You have to set \fBmda\fR (see below) as well.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
274
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
275 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
276 \fBmaildir_users = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
277
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
278 A list of users which wish delivery to a qmail style maildir.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
279 The path to maildir is ~/Maildir/.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
280 The maildir will be created if it does not exist.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
281
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
282 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
283 \fBmda = \fIexpand string\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
284
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
285 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
286 set this to a command.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
287 The argument will be expanded on delivery time,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
288 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
289 Variables you can use are:
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
290
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
291 uid - the unique message id.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
292 This is not necessarily identical with the Message ID as given in the Message ID: header.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
293
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
294 received_host - the host the mail was received from
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
295
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
296 ident - the ident, this is either the ident delivered by the ident protocol
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
297 or the user id of the sender if the message was received locally.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
298
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
299 return_path_local - the local part of the return path (sender).
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
300
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
301 return_path_domain - the domain part of the return path (sender).
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
302
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
303 return_path - the complete return path (sender).
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
304
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
305 rcpt_local - the local part of the recipient.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
306
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
307 rcpt_domain - the domain part of the recipient.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
308
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
309 rcpt - the complete recipient address.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
310
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
311 Example:
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
312
16
163aa299bedb fixed man pages
meillo@marmaro.de
parents: 3
diff changeset
313 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
314
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
315 For the mda, as for pipe commands, a few environment variables will be set as well.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
316 See \fBmasqmail(8)\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
317 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
318 otherwise they will be tried to be expanded with the internal variables.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
319
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
320 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
321 \fBmda_fromline = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
322
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
323 If this is set, a from line will be prepended to the output stream whenever
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
324 a message is delivered to an mda.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
325 Default is false.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
326
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
327 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
328 \fBmda_fromhack = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
329
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
330 If this is set, each line beginning with `From ' is replaced with `>From '
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
331 whenever a message is delivered to an mda.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
332 You probably want this if you have set \fBmda_fromline\fR above.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
333 Default is false.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
334
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
335 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
336 \fBonline_detect = \fIstring\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
337
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
338 Defines the method masqmail uses to detect whether there is currently an online connection.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
339 It can have the values \fBfile\fR, \fBpipe\fR, or \fBmserver\fR.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
340
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
341 When it is set to \fBfile\fR, masqmail first checks for the existence of \fBonline_file\fR
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
342 (see below) and if it exists, it reads it.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
343 The content of the file should be the name of the current connection as defined
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
344 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
345
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
346 When it is set to \fBpipe\fR, masqmail calls the executable given by the
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
347 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
348
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
349 When it is set to \fBmserver\fR, masqmail connects to the masqdialer server
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
350 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
351 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
352
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
353 No matter how masqmail detects the online status,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
354 only messages that are accepted at online time will be delivered using the connection.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
355 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
356
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
357 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
358 \fBonline_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
359
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
360 This is the name of the file checked for when masqmail determines whether it is online.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
361 The file should only exist when there is currently a connection.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
362 Create it in your ip-up script with e.g.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
363
37
4fee89792559 updated config example and man page to new default online file
meillo@marmaro.de
parents: 34
diff changeset
364 echo \-n <name> > /var/run/masqmail/masqmail-route
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
365
37
4fee89792559 updated config example and man page to new default online file
meillo@marmaro.de
parents: 34
diff changeset
366 chmod 0644 /var/run/masqmail/masqmail-route
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
367
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
368 Do not forget to delete it in your ip-down script.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
369
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
370 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
371 \fBonline_pipe = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
372
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
373 This is the name of the executable which will be called to determine the online status.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
374 This executable should just print the name of the current connection to
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
375 the standard output and return a zero status code.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
376 masqmail assumes it is offline if the script returns with a non zero status.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
377 Simple example:
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
378
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
379 #!/bin/sh
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
380
37
4fee89792559 updated config example and man page to new default online file
meillo@marmaro.de
parents: 34
diff changeset
381 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
382
37
4fee89792559 updated config example and man page to new default online file
meillo@marmaro.de
parents: 34
diff changeset
383 cat /var/run/masqmail/masqmail-route
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
384
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
385 exit 0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
386
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
387 Of course, instead of the example above you could as well use \fBfile\fR as
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
388 the online detection method, but you can do something more sophisticated.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
389
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
390 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
391 \fBmserver_iface = \fIinterface\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
392
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
393 The interface the masqdialer server is listening to.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
394 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
395 But using this option, you can also let masqmail run on another host by setting
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
396 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
397
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
398 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
399 \fBget.\fIname\fR = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
400
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
401 Replace \fIname\fR with a name to identify a get configuration.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
402 Set this to a filename for the get configuration.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
403 These files will be used to retrieve mail when called with the \-g option.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
404
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
405 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
406 \fBonline_gets.\fIname\fR = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
407
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
408 Replace \fIname\fR with a name to identify an online configuration.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
409 Set this to a filename (or a list of filenames) for the get configuration.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
410 These files will be used to retrieve mail when called with the \-go option.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
411
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
412 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
413 \fBident_trusted_nets = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
414
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
415 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
416 from which the ident given by the ident protocol will be trusted,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
417 so a user can delete his mail from the queue if the ident is identical to his login name.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
418
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
419 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
420 \fBerrmsg_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
421
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
422 Set this to a template which will be used to generate delivery failure reports.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
423 Variable parts within the template begin with a dollar sign and are identical
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
424 to those which can be used as arguments for the mda command, see \fBmda\fR above.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
425 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
426 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
427 the message headers and the message body of the failed message.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
428
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
429 Default is /usr/share/masqmail/tpl/failmsg.tpl.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
430
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
431 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
432 \fBwarnmsg_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
433
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
434 Set this to a template which will be used to generate delivery warning reports.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
435 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
436
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
437 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
438
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
439 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
440 \fBwarn_intervals\fR = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
441
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
442 Set this to a list of time intervals, at which delivery warnings
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
443 (starting with the receiving time of the message) shall be generated.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
444
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
445 A warning will only be generated just after an attempt to deliver the mail
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
446 and if that attempt failed temporarily.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
447 So a warning may be generated after a longer time, if there was no attempt before.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
448
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
449 Default is "1h;4h;8h;1d;2d;3d"
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
450
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
451 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
452 \fBmax_defer_time\fR = \fItime\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
453
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
454 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
455 When this time is exceeded, it will be handled as a delivery failure,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
456 and the message will be bounced.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
457
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
458 The excedence of this time will only be noticed if the message was actually tried to be delivered.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
459 If, for example, the message can only be delivered when online,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
460 but you have not been online for that time, no bounce will be generated.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
461
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
462 Default is 4d (4 days)
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
463
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
464 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
465 \fBlog_user = \fIname\fR
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
466
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
467 Replace \fIname\fR with a valid local or remote mail address.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
468
44
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
469 If this option is set, then a copy of every mail,
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
470 that passes through the masqmail system will also be sent to the given mail address.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
471
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
472 For example you can feed your mails into a program like hypermail
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
473 for archiving purpose by placing an appropriate pipe command in masqmail.alias
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
474
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
475
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
476 .SH AUTHOR
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
477
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
478 Masqmail was written by Oliver Kurth.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
479 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
480
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
481 You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
26
607221b0dac1 added myself as maintainer; updated URL of the website
meillo@marmaro.de
parents: 16
diff changeset
482 There is also a mailing list, you will find information about it at masqmail's main site.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
483
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
484
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
485 .SH BUGS
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
486
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
487 Please report bugs to the mailing list.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
488
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
489
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
490 .SH SEE ALSO
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
491
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
492 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR