masqmail-0.2

annotate docs/old-manual/docs/masqmail.get.5.html @ 56:f6a6f55b7b9e

added old manual from the old website it is dated May/July 2000
author meillo@marmaro.de
date Sat, 29 May 2010 21:51:13 +0200
parents
children
rev   line source
meillo@56 1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
meillo@56 2 <tr><td><h1>masqmail.get</h1>
meillo@56 3 <h2>masqmail get configuration file</h2>
meillo@56 4
meillo@56 5
meillo@56 6 <h2>Description</h2>
meillo@56 7 <p>This man page describes the options available for the
meillo@56 8 masqmail get configuration.</p>
meillo@56 9
meillo@56 10
meillo@56 11
meillo@56 12
meillo@56 13 <h2>Options</h2>
meillo@56 14
meillo@56 15
meillo@56 16
meillo@56 17 <p><b>protocol</b> = <em>string</em></p>
meillo@56 18
meillo@56 19 <p>The protocol with which you retrieve your mail. Currently only
meillo@56 20 'pop3' and 'apop' are supported. There is no default.</p>
meillo@56 21
meillo@56 22
meillo@56 23
meillo@56 24
meillo@56 25 <p><b>server</b> = <em>string</em></p>
meillo@56 26
meillo@56 27 <p>The server you get your mail from.</p>
meillo@56 28
meillo@56 29
meillo@56 30
meillo@56 31
meillo@56 32 <p><b>resolve_list</b> = <em>list</em></p>
meillo@56 33
meillo@56 34 <p>Specify the method how the domain of the server is resolved. Possible values are
meillo@56 35 dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX
meillo@56 36 pointer to a list of host names, these will be tried each in order
meillo@56 37 (lowest preference value first, equal preference values in random
meillo@56 38 order). For 'dns_a', the domain is assumed to be an A pointer. For
meillo@56 39 'byname', the library function <b>gethostbyname (3)</b> will be used.</p>
meillo@56 40 <p>The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.</p>
meillo@56 41
meillo@56 42
meillo@56 43
meillo@56 44
meillo@56 45 <p><b>user</b> = <em>string</em></p>
meillo@56 46
meillo@56 47 <p>Your login name.</p>
meillo@56 48
meillo@56 49
meillo@56 50
meillo@56 51
meillo@56 52 <p><b>pass</b> = <em>string</em></p>
meillo@56 53
meillo@56 54 <p>Your password.</p>
meillo@56 55
meillo@56 56
meillo@56 57
meillo@56 58
meillo@56 59 <p><b>address</b> = <em>address</em></p>
meillo@56 60
meillo@56 61 <p>The address where the retrieved mail should be sent to. It can be
meillo@56 62 any address, but you probably want to set this to a local address on
meillo@56 63 your LAN.</p>
meillo@56 64
meillo@56 65
meillo@56 66
meillo@56 67
meillo@56 68 <p><b>return_path</b> = <em>address</em></p>
meillo@56 69
meillo@56 70 <p>If set, masqmail sets the return path to this address. Bounces
meillo@56 71 generated during further delivery will be sent to this address. If
meillo@56 72 unset, masqmail looks for the Return-Path: header in the mail, if
meillo@56 73 this does not exist it uses the From: address and if this fails,
meillo@56 74 postmaster will be used.
meillo@56 75 </p><p>
meillo@56 76 It is in most cases not useful to set this to the same address as
meillo@56 77 the 'address' option as this may generate multiple bounces.
meillo@56 78 postmaster is recommended.</p>
meillo@56 79
meillo@56 80
meillo@56 81
meillo@56 82
meillo@56 83 <p><b>do_keep</b> = <em>boolean</em></p>
meillo@56 84
meillo@56 85 <p>If you want to keep your mail on the server after you retrieved it,
meillo@56 86 set this to true. It is recommended that you also set do_uidl,
meillo@56 87 otherwise you will get the mail again each time you connect to the
meillo@56 88 server. Masqmail does not check any headers before it retrieves mail,
meillo@56 89 which may mark it as already fetched. Note that this behaviour is
meillo@56 90 different to that of fetchmail. The default is false.</p>
meillo@56 91
meillo@56 92
meillo@56 93
meillo@56 94
meillo@56 95 <p><b>do_uidl</b> = <em>boolean</em></p>
meillo@56 96
meillo@56 97 <p>If set, MasqMail keeps a list of unique IDs of mails already
meillo@56 98 fetched, so that they will not be retrieved again. Default is false.</p>
meillo@56 99
meillo@56 100
meillo@56 101
meillo@56 102
meillo@56 103 <p><b>do_uidl_dele</b> = <em>boolean</em></p>
meillo@56 104
meillo@56 105 <p>If set, and <b>do_uidl</b> is also set, MasqMail sends a delete (DELE)
meillo@56 106 command to the server for each message uid in the uid listing at the
meillo@56 107 beginning of the session. This prevents mail to be left on the server if
meillo@56 108 masqmail gets interrupted during a session before it can send the QUIT
meillo@56 109 command to the server. Default is false.
meillo@56 110 </p>
meillo@56 111
meillo@56 112
meillo@56 113
meillo@56 114
meillo@56 115 <p><b>max_size</b> = <em>numeric</em></p>
meillo@56 116
meillo@56 117 <p>If set to a value > 0, only messages smaller than this in bytes will be
meillo@56 118 retrieved. The default is 0.</p>
meillo@56 119
meillo@56 120
meillo@56 121
meillo@56 122
meillo@56 123 <p><b>max_count</b> = <em>numeric</em></p>
meillo@56 124
meillo@56 125 <p>If set to a value > 0, only <b>max_count</b> messages will be retrieved.
meillo@56 126 The default is 0.</p>
meillo@56 127
meillo@56 128
meillo@56 129
meillo@56 130
meillo@56 131 <p><b>wrapper</b> = <em>command</em></p>
meillo@56 132
meillo@56 133 <p>If set, instead of opening a connection to a remote server, <em>command</em> will
meillo@56 134 be called and all traffic will be piped to its
meillo@56 135 stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p>
meillo@56 136 <p>Example for ssl tunneling:</p>
meillo@56 137 <p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p>
meillo@56 138
meillo@56 139
meillo@56 140
meillo@56 141
meillo@56 142
meillo@56 143 <h2>Author</h2>
meillo@56 144
meillo@56 145 <p>masqmail was written by Oliver Kurth
meillo@56 146 <oku@masqmail.cx></p><p>You will find the newest version of
meillo@56 147 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it
meillo@56 148 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,
meillo@56 149 you will find information about it at masqmails main site.</p>
meillo@56 150
meillo@56 151
meillo@56 152
meillo@56 153 <h2>Bugs</h2>
meillo@56 154
meillo@56 155 <p>You should report them to the mailing list.</p>
meillo@56 156
meillo@56 157
meillo@56 158
meillo@56 159 <h2>See also</h2>
meillo@56 160
meillo@56 161 <p>
meillo@56 162 <a href="masqmail.8.html">masqmail</a>, <a href="masqmail.route.5.html">masqmail.route</a>, <a href="masqmail.conf.5.html">masqmail.conf</a>
meillo@56 163 </p>
meillo@56 164
meillo@56 165
meillo@56 166
meillo@56 167 <h2>Comments</h2>
meillo@56 168
meillo@56 169 <p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same
meillo@56 170 author.</p>
meillo@56 171
meillo@56 172
meillo@56 173
meillo@56 174 </td></tr></table></center>
meillo@56 175 </body>