Mercurial > masqmail-0.2
annotate man/masqmail.get.5 @ 190:fbb3417c1a54 default tip
Minor fixes in man pages, reported by lintian(1)
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Mon, 29 Aug 2011 19:22:51 +0200 |
| parents | 4714f093fc77 |
| children |
| rev | line source |
|---|---|
|
186
4714f093fc77
updated version and dates
markus schnalke <meillo@marmaro.de>
parents:
181
diff
changeset
|
1 .TH masqmail.get 5 2011-07-27 masqmail-0.2.30 "File Formats" |
| 34 | 2 |
| 0 | 3 .SH NAME |
| 4 masqmail.get \- masqmail get configuration file | |
| 34 | 5 |
| 6 | |
| 0 | 7 .SH DESCRIPTION |
| 8 | |
| 9 This man page describes the options available for the masqmail get configuration. | |
| 10 | |
| 34 | 11 |
| 0 | 12 .SH OPTIONS |
| 34 | 13 |
| 0 | 14 .TP |
| 34 | 15 \fBprotocol\fR = \fIstring\fR |
| 0 | 16 |
| 34 | 17 The protocol with which you retrieve your mail. |
| 18 Currently only `pop3' and `apop' are supported. | |
| 19 There is no default. | |
| 20 | |
| 0 | 21 .TP |
| 34 | 22 \fBserver\fR = \fIstring\fR |
| 0 | 23 |
| 24 The server you get your mail from. | |
| 34 | 25 |
| 0 | 26 .TP |
|
130
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
27 \fBport\fR = \fInumber\fR |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
28 |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
29 The port number of \fBserver\fP to connect to. |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
30 |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
31 Default: 110. |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
32 |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
33 .TP |
| 34 | 34 \fBresolve_list\fR = \fIlist\fR |
| 0 | 35 |
| 34 | 36 Specify the method how the domain of the server is resolved. |
| 37 Possible values are dns_mx, dns_a, byname. | |
| 38 For `dns_mx', the domain is assumed to be an MX pointer to a list of host names, | |
| 39 these will be tried each in order | |
| 40 (lowest preference value first, equal preference values in random order). | |
| 41 For `dns_a', the domain is assumed to be an A pointer. | |
| 42 For `byname', the library function \fBgethostbyname(3)\fR will be used. | |
| 0 | 43 |
| 34 | 44 The default is "dns_a;byname". |
| 45 It does not make much sense here to use `dns_mx'. | |
| 46 | |
| 0 | 47 .TP |
| 34 | 48 \fBuser\fR = \fIstring\fR |
| 0 | 49 |
| 50 Your login name. | |
| 34 | 51 |
| 0 | 52 .TP |
| 34 | 53 \fBpass\fR = \fIstring\fR |
| 0 | 54 |
| 55 Your password. | |
| 56 | |
| 34 | 57 .TP |
| 58 \fBaddress\fR = \fIaddress\fR | |
| 59 | |
| 60 The address where the retrieved mail should be sent to. | |
| 61 It can be any address, but you probably want to set this to a local address on your LAN. | |
| 0 | 62 |
| 63 .TP | |
| 34 | 64 \fBreturn_path\fR = \fIaddress\fR |
| 0 | 65 |
| 34 | 66 If set, masqmail sets the return path to this address. |
| 67 Bounces generated during further delivery will be sent to this address. | |
| 68 If unset, masqmail looks for the Return-Path: header in the mail, | |
| 69 if this does not exist it uses the From: address and if this fails, postmaster will be used. | |
| 0 | 70 |
| 34 | 71 It is in most cases not useful to set this to the same address as the `address' |
| 72 option as this may generate multiple bounces. | |
| 73 postmaster is recommended. | |
| 0 | 74 |
| 75 .TP | |
| 34 | 76 \fBdo_keep\fR = \fIboolean\fR |
| 0 | 77 |
| 34 | 78 If you want to keep your mail on the server after you retrieved it, set this to true. |
| 79 It is recommended that you also set do_uidl, | |
| 80 otherwise you will get the mail again each time you connect to the server. | |
| 81 Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched. | |
| 82 Note that this behaviour is different to that of fetchmail. | |
| 83 The default is false. | |
| 0 | 84 |
| 85 .TP | |
| 34 | 86 \fBdo_uidl\fR = \fIboolean\fR |
| 0 | 87 |
| 34 | 88 If set, masqmail keeps a list of unique IDs of mails already fetched, |
| 89 so that they will not be retrieved again. | |
| 90 Default is false. | |
| 91 | |
| 0 | 92 .TP |
| 34 | 93 \fBdo_uidl_dele\fR = \fIboolean\fR |
| 0 | 94 |
| 34 | 95 If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command |
| 96 to the server for each message uid in the uid listing at the beginning of the session. | |
| 97 This prevents mail to be left on the server if masqmail gets interrupted during | |
| 98 a session before it can send the QUIT command to the server. | |
| 99 Default is false. | |
| 100 | |
| 0 | 101 .TP |
| 34 | 102 \fBmax_size\fR = \fInumeric\fR |
| 0 | 103 |
| 34 | 104 If set to a value > 0, only messages smaller than this in bytes will be retrieved. |
| 105 The default is 0. | |
| 106 | |
| 0 | 107 .TP |
| 34 | 108 \fBmax_count\fR = \fInumeric\fR |
| 0 | 109 |
| 34 | 110 If set to a value > 0, only \fBmax_count\fR messages will be retrieved. |
| 111 The default is 0. | |
| 0 | 112 |
| 34 | 113 .TP |
|
130
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
114 \fBmax_size_delete\fR = \fIboolean\fR |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
115 |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
116 If \fBmax_size\fP > 0 and \fBdo_uidl_dele\fP is set, |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
117 delete messages that are larger than \fImax_size\fP on the server |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
118 WITHOUT retrieving them. |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
119 Be careful with this option. |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
120 |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
121 Default: false |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
122 |
|
cf444d5458a5
documented undocumented get config options
meillo@marmaro.de
parents:
95
diff
changeset
|
123 .TP |
| 34 | 124 \fBwrapper\fR = \fIcommand\fR |
| 0 | 125 |
| 34 | 126 If set, instead of opening a connection to a remote server, |
| 127 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout. | |
| 128 Purpose is to tunnel ip traffic, e.g. for ssl. | |
| 0 | 129 |
| 130 Example for ssl tunneling: | |
| 131 | |
| 16 | 132 wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null" |
| 34 | 133 |
| 134 | |
| 0 | 135 .SH AUTHOR |
| 136 | |
| 34 | 137 Masqmail was written by Oliver Kurth. |
| 138 It is now maintained by Markus Schnalke <meillo@marmaro.de>. | |
| 0 | 139 |
|
95
e01fed4846e4
masqmail's homepage moved prog.marmaro.de/masqmail -> marmaro.de/prog/masqmail
meillo@marmaro.de
parents:
57
diff
changeset
|
140 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR. |
|
26
607221b0dac1
added myself as maintainer; updated URL of the website
meillo@marmaro.de
parents:
16
diff
changeset
|
141 There is also a mailing list, you will find information about it at masqmail's main site. |
| 0 | 142 |
| 34 | 143 |
| 0 | 144 .SH BUGS |
| 145 | |
| 34 | 146 Please report bugs to the mailing list. |
| 147 | |
| 0 | 148 |
| 149 .SH SEE ALSO | |
| 150 | |
| 34 | 151 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR |