docs/diploma

annotate docs/masqmail.cx/docs/masqmail.get.5.html @ 1:7b2a5fe2aedd

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