masqmail

annotate debian/masqmail.templates @ 0:08114f7dcc23

find changesets by author, revision, files, or words in the commit message
this is masqmail-0.2.21 from oliver kurth
author meillo@marmaro.de
date Fri, 26 Sep 2008 17:05:23 +0200
parents
children af25f5c39d90
rev   line source
meillo@0 1 Template: masqmail/note_moved_tpl
meillo@0 2 Type: note
meillo@0 3 Description: Failure notice templates have been moved
meillo@0 4 The delivery failure notices that lived in /etc/masqmail/tpl are now in
meillo@0 5 /usr/share/masqmail/tpl/.
meillo@0 6 .
meillo@0 7 You will notice this only if you have changed the location in
meillo@0 8 masqmail.conf or changed the templates.
meillo@0 9 .
meillo@0 10 Since they are no longer conffiles because of the move, you should
meillo@0 11 give a customized version another name, otherwise it will be
meillo@0 12 overwritten on the next upgrade.
meillo@0 13
meillo@0 14 Template: masqmail/note_pcmcia_scripts
meillo@0 15 Type: note
meillo@0 16 Description: Removed executable bit in scripts in /etc/pcmcia/ip-{up,down}.d/
meillo@0 17 The scripts in /etc/pcmcia/ip-{up,down}.d/ are deprecated
meillo@0 18 and are replaced with the scripts /etc/network/if-{up,down}.d/1masqmail, which
meillo@0 19 will work for _any_ network card (not just pcmcia). The executable bit of the
meillo@0 20 old scripts has been removed, because otherwise they and the new scripts would be
meillo@0 21 exececuted, which is not desired.
meillo@0 22 .
meillo@0 23 You should remove these scripts from /etc/pcmcia/ip-{up,down}.d/. If you still want
meillo@0 24 to use them, just reset the executable bit.
meillo@0 25 .
meillo@0 26 Whatever you do, you will never see the note again.
meillo@0 27
meillo@0 28 Template: masqmail/manage_config_with_debconf
meillo@0 29 Type: boolean
meillo@0 30 Default: true
meillo@0 31 Description: Manage masqmail.conf using debconf?
meillo@0 32 The /etc/masqmail/masqmail.conf file can be handled automatically
meillo@0 33 by debconf, or manually by you.
meillo@0 34 .
meillo@0 35 Note that only specific, marked sections of the configuration file will be
meillo@0 36 handled by debconf if you select this option; if those markers are absent,
meillo@0 37 you will have to update the file manually, or move or delete the file.
meillo@0 38
meillo@0 39 Template: masqmail/move_existing_nondebconf_config
meillo@0 40 Type: boolean
meillo@0 41 Default: false
meillo@0 42 Description: Replace existing /etc/masqmail/masqmail.conf file?
meillo@0 43 The existing /etc/masqmail/masqmail.conf file currently on the system does
meillo@0 44 not contain a marked section for debconf to write its data.
meillo@0 45 .
meillo@0 46 If you select this option, the existing configuration
meillo@0 47 file will be backed up to /etc/masqmail/masqmail.conf.debconf-backup and a
meillo@0 48 new file written to /etc/masqmail/masqmail.conf. If you do not select this
meillo@0 49 option, the existing configuration file will not be managed by debconf,
meillo@0 50 and no further questions about masqmail configuration will be
meillo@0 51 asked.
meillo@0 52
meillo@0 53 Template: masqmail/host_name
meillo@0 54 Type: string
meillo@0 55 Default:
meillo@0 56 Description: The name with which masqmail identifies itself to others
meillo@0 57 This is most likely your hostname. It is used in its SMTP greeting
meillo@0 58 banner, for expanding unqualified addresses, the Message ID and so on.
meillo@0 59
meillo@0 60 Template: masqmail/local_hosts
meillo@0 61 Type: string
meillo@0 62 Default:
meillo@0 63 Description: hosts considered local
meillo@0 64 This is a list of hosts, separated with semicolons (;), which are
meillo@0 65 considered 'local', ie. mail to this host will be delivered to a
meillo@0 66 mailbox (or Maildir or MDA) on this host.
meillo@0 67 .
meillo@0 68 You will most likely insert 'localhost', your hostname in its fully
meillo@0 69 qualified version, and just the simple hostname here.
meillo@0 70 .
meillo@0 71 You can also use wildcard expressions like '*' and '?'.
meillo@0 72
meillo@0 73 Template: masqmail/local_nets
meillo@0 74 Type: string
meillo@0 75 Default:
meillo@0 76 Description: nets considered local, for immediate delivery attempts
meillo@0 77 This is a list of hosts, separated with semicolons (;), which are
meillo@0 78 on your local network, ie. they are always reachable, without a
meillo@0 79 dialup connection. Mail to these hosts will be delivered immediately,
meillo@0 80 without checking for the online status.
meillo@0 81 .
meillo@0 82 You can use wildcards expressions like '*' and '?', eg. *.yournet.local
meillo@0 83 .
meillo@0 84 If you have only one box, you can leave this empty. If you do not want
meillo@0 85 to use masqmail as an offline MTA, and the whole internet or another mail
meillo@0 86 server which accepts outgoing mail is all time
meillo@0 87 reachable to you, just insert '*'.
meillo@0 88
meillo@0 89 Template: masqmail/listen_addresses
meillo@0 90 Type: string
meillo@0 91 Default: localhost:25
meillo@0 92 Description: accept connections on these interfaces
meillo@0 93 masqmail, for security reasons, does not listen an all network interfaces
meillo@0 94 by default. If there are no other hosts connected to your host, just leave
meillo@0 95 this 'localhost:25'. If there are other hosts that may want to send SMTP
meillo@0 96 messages to this host, add the address of you network interface here,
meillo@0 97 eg.: localhost:25;192.168.1.2:25.
meillo@0 98 .
meillo@0 99 Of course you can also replace the '25' with another port number, but
meillo@0 100 this is unusual.
meillo@0 101
meillo@0 102 Template: masqmail/use_syslog
meillo@0 103 Type: boolean
meillo@0 104 Default: false
meillo@0 105 Description: use syslogd for logs?
meillo@0 106 You can decide whether masqmail should log via syslog or not. If not,
meillo@0 107 logs will be written to /var/log/masqmail/masqmail.log.
meillo@0 108
meillo@0 109 Template: masqmail/online_detect
meillo@0 110 Type: select
meillo@0 111 Choices: file, pipe
meillo@0 112 Default: file
meillo@0 113 Description: the online detection method
meillo@0 114 masqmail has different methods to determine whether it is online or not,
meillo@0 115 these are 'file','pipe'.
meillo@0 116 .
meillo@0 117 For 'file', masqmail checks for the existence of a file, and, if it
meillo@0 118 exists, reads from it the name of the connection.
meillo@0 119 .
meillo@0 120 For 'pipe', masqmail calls a program or script, which outputs the name
meillo@0 121 if online or nothing if not. You can use eg. the program guessnet for this.
meillo@0 122
meillo@0 123 Template: masqmail/online_file
meillo@0 124 Type: string
meillo@0 125 Default: /var/run/masqmail-route
meillo@0 126 Description: the name of the file to determine the online status
meillo@0 127
meillo@0 128 Template: masqmail/online_pipe
meillo@0 129 Type: string
meillo@0 130 Default:
meillo@0 131 Description: the name of the program to determine the online status
meillo@0 132 Note that, when this program is called, masqmail has the user id 'mail'.
meillo@0 133
meillo@0 134 Template: masqmail/mbox_default
meillo@0 135 Type: select
meillo@0 136 Choices: mbox, mda, maildir
meillo@0 137 Default: mbox
meillo@0 138 Description: local delivery style
meillo@0 139 Local mail can be delivered to a mailbox, to an MDA (eg. procmail)
meillo@0 140 or to a qmail style maildir in the users home dir.
meillo@0 141 .
meillo@0 142 You can select the default style here. You can configure this also
meillo@0 143 on a per-user basis with the options mbox_users, mda_users and
meillo@0 144 maildir_users.
meillo@0 145
meillo@0 146 Template: masqmail/mda
meillo@0 147 Type: string
meillo@0 148 Default: /usr/bin/procmail -Y -d ${rcpt_local}
meillo@0 149 Description: The MDA command line including options
meillo@0 150 Give here the path to the mda, including its arguments. You can use
meillo@0 151 substitution values here, eg. ${rcpt_local} for the user name.
meillo@0 152 .
meillo@0 153 For other substitutions please see the man page.
meillo@0 154 .
meillo@0 155 (This question is also asked if you did not set mbox_default to mda,
meillo@0 156 since you can use mda for a set of users specially)
meillo@0 157
meillo@0 158 Template: masqmail/alias_local_caseless
meillo@0 159 Type: boolean
meillo@0 160 Default: false
meillo@0 161 Description: Alias expansion regarding case or not
meillo@0 162 masqmail uses the file /etc/aliases to redirect local addresses.
meillo@0 163 The search for a match in /etc/aliases can be regarding upper/lower
meillo@0 164 case or insensitive to case.
meillo@0 165
meillo@0 166 Template: masqmail/init_smtp_daemon
meillo@0 167 Type: boolean
meillo@0 168 Default: true
meillo@0 169 Description: Start SMTP listening daemon?
meillo@0 170 Select 'yes' if you want masqmail to start as an SMTP listening
meillo@0 171 daemon. You will need this if:
meillo@0 172 .
meillo@0 173 - there are other hosts in your local network that may want to send mail via this host
meillo@0 174 .
meillo@0 175 - you use a mail client that sends mail via SMTP (netscape, mozilla are examples)
meillo@0 176 .
meillo@0 177 If in doubt, select 'yes'.
meillo@0 178
meillo@0 179 Template: masqmail/init_queue_daemon
meillo@0 180 Type: boolean
meillo@0 181 Default: true
meillo@0 182 Description: Start SMTP queue running daemon?
meillo@0 183 Select 'yes' if you want masqmail to start as a queue running daemon. You will
meillo@0 184 need this very likely. It is used for mail that cannot delivered immediately,
meillo@0 185 either because of delivery failures or because you were not online on
meillo@0 186 the first attempt to send a mail.
meillo@0 187 .
meillo@0 188 If in doubt, select 'yes'.
meillo@0 189
meillo@0 190 Template: masqmail/queue_daemon_ival
meillo@0 191 Type: string
meillo@0 192 Default: -q10m
meillo@0 193 Description: The interval for the queue running daemon
meillo@0 194 Set the interval for the queue running daemon. -q10m means flush the queue every
meillo@0 195 10 minutes.
meillo@0 196 .
meillo@0 197 The format is -q, followed by an numeric value and one of the letters s,m,h,d,w for
meillo@0 198 seconds, minutes, hours, days or weeks respectively.
meillo@0 199 .
meillo@0 200 Reasonable values are between 5 minutes (-q5m) and 2 hours (-q2h).
meillo@0 201
meillo@0 202 Template: masqmail/init_fetch_daemon
meillo@0 203 Type: boolean
meillo@0 204 Default: false
meillo@0 205 Description: Start POP3 fetch daemon?
meillo@0 206 Select 'yes' if you want masqmail to start as a fetch daemon. If you say 'yes',
meillo@0 207 masqmail will try to fetch mail from pop servers that you configure in regular
meillo@0 208 intervals, detecting the online status first.
meillo@0 209 .
meillo@0 210 No matter what you choose here, you can later select whether you want to fetch
meillo@0 211 mail the moment you get online.
meillo@0 212
meillo@0 213 Template: masqmail/fetch_daemon_ival
meillo@0 214 Type: string
meillo@0 215 Default: -go5m
meillo@0 216 Description: The interval for the fetch daemon
meillo@0 217 Set the interval for the fetch daemon. -go5m means try to fetch mail every
meillo@0 218 5 minutes.
meillo@0 219 .
meillo@0 220 The format is -go, followed by an numeric value and one of the letters s,m,h,d,w for
meillo@0 221 seconds, minutes, hours, days or weeks respectively.
meillo@0 222 .
meillo@0 223 Reasonable values are between 2 minutes (-go2m) and 2 hours (-go2h).
meillo@0 224
meillo@0 225 Template: masqmail/ipup_runqueue
meillo@0 226 Type: boolean
meillo@0 227 Default: true
meillo@0 228 Description: flush mail queue when you get online?
meillo@0 229 Select 'yes' if you want masqmail to immediately flush its mail queue as soon
meillo@0 230 as you go online. This will be done in the ip-up script in /etc/ppp/ip-up or
meillo@0 231 in /etc/network/if-up.d/.
meillo@0 232
meillo@0 233 Template: masqmail/ipup_fetch
meillo@0 234 Type: boolean
meillo@0 235 Default: false
meillo@0 236 Description: fetch mail when you get online?
meillo@0 237 Select 'yes' if you want masqmail to immediately fetch mail from POP3
meillo@0 238 servers as soon as you go online. This will be done in the ip-up script
meillo@0 239 in /etc/ppp/ip-up or in /etc/network/if-up.d/.
meillo@0 240
meillo@0 241 Template: masqmail/ifup_ifaces
meillo@0 242 Type: string
meillo@0 243 Default: all
meillo@0 244 Description: a list of interfaces used for masqmail online detection
meillo@0 245 Set this to a list of network interfaces. When any of those interfaces go
meillo@0 246 up, the current online status will be used for queue runs and/or fetching
meillo@0 247 mails. The list will be used in the /etc/ppp/ip-up and /etc/network/if-up.d/
meillo@0 248 scripts, when the interface goes up.
meillo@0 249 .
meillo@0 250 A reasonable choice is eg. 'ppp0' for a desktop at home, or 'ppp0 eth0' for
meillo@0 251 a notebook". If this is set to eg. 'ppp0', nothing happens if eth0 goes up.
meillo@0 252 .
meillo@0 253 Set to 'all' for all interfaces, or 'none' for no interfaces.
meillo@0 254
meillo@0 255 Template: masqmail/you_are_not_finished
meillo@0 256 Type: note
meillo@0 257 Description: You are not finished
meillo@0 258 Although masqmail is not as feature rich as other MTAs like sendmail
meillo@0 259 or exim, this debconf does not (yet) do all configurations for you.
meillo@0 260 .
meillo@0 261 To make use of masqmail, you still have to create some sub configuration
meillo@0 262 files for sending mail to some ISP and/or to fetch mail. masqmail has
meillo@0 263 lots of man pages and examples which are hopefully clear enough to
meillo@0 264 explain to you how to do it.
meillo@0 265 .
meillo@0 266 You should start with the man pages masqmail.conf, masqmail.route
meillo@0 267 and masqmail.get.