1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/xml/masqmail.get.5.xml	Fri Sep 26 17:05:23 2008 +0200
     1.3 @@ -0,0 +1,165 @@
     1.4 +<?xml version="1.0" standalone='no'?>
     1.5 +<!DOCTYPE spec SYSTEM "man.dtd">
     1.6 +
     1.7 +<manpage name="masqmail.get" section="5" desc="masqmail get configuration file">
     1.8 +
     1.9 +<description> <p>This man page describes the options available for the
    1.10 +masqmail get configuration.</p>
    1.11 +
    1.12 +</description>
    1.13 +
    1.14 +<options>
    1.15 +
    1.16 +<option>
    1.17 +<p><opt>protocol</opt> = <arg>string</arg></p>
    1.18 +<optdesc>
    1.19 +<p>The protocol with which you retrieve your mail. Currently only
    1.20 +'pop3' and 'apop' are supported. There is no default.</p>
    1.21 +</optdesc>
    1.22 +</option>
    1.23 +
    1.24 +<option>
    1.25 +<p><opt>server</opt> = <arg>string</arg></p>
    1.26 +<optdesc>
    1.27 +<p>The server you get your mail from.</p>
    1.28 +</optdesc>
    1.29 +</option>
    1.30 +
    1.31 +<option>
    1.32 +<p><opt>resolve_list</opt> = <arg>list</arg></p>
    1.33 +<optdesc>
    1.34 +<p>Specify the method how the domain of the server is resolved. Possible values are
    1.35 +dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX
    1.36 +pointer to a list of host names, these will be tried each in order
    1.37 +(lowest preference value first, equal preference values in random
    1.38 +order). For 'dns_a', the domain is assumed to be an A pointer. For
    1.39 +'byname', the library function <manref name="gethostbyname" section="3"/> will be used.</p>
    1.40 +<p>The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.</p>
    1.41 +</optdesc>
    1.42 +</option>
    1.43 +
    1.44 +<option>
    1.45 +<p><opt>user</opt> = <arg>string</arg></p>
    1.46 +<optdesc>
    1.47 +<p>Your login name.</p>
    1.48 +</optdesc>
    1.49 +</option>
    1.50 +
    1.51 +<option>
    1.52 +<p><opt>pass</opt> = <arg>string</arg></p>
    1.53 +<optdesc>
    1.54 +<p>Your password.</p>
    1.55 +</optdesc>
    1.56 +</option>
    1.57 +
    1.58 +<option>
    1.59 +<p><opt>address</opt> = <arg>address</arg></p>
    1.60 +<optdesc>
    1.61 +<p>The address where the retrieved mail should be sent to. It can be
    1.62 +any address, but you probably want to set this to a local address on
    1.63 +your LAN.</p>
    1.64 +</optdesc>
    1.65 +</option>
    1.66 +
    1.67 +<option>
    1.68 +<p><opt>return_path</opt> = <arg>address</arg></p>
    1.69 +<optdesc>
    1.70 +<p>If set, masqmail sets the return path to this address. Bounces
    1.71 +generated during further delivery will be sent to this address. If
    1.72 +unset, masqmail looks for the Return-Path: header in the mail, if
    1.73 +this does not exist it uses the From: address and if this fails,
    1.74 +postmaster will be used.
    1.75 +</p><p>
    1.76 +It is in most cases not useful to set this to the same address as
    1.77 +the 'address' option as this may generate multiple bounces.
    1.78 +postmaster is recommended.</p>
    1.79 +</optdesc>
    1.80 +</option>
    1.81 +
    1.82 +<option>
    1.83 +<p><opt>do_keep</opt> = <arg>boolean</arg></p>
    1.84 +<optdesc>
    1.85 +<p>If you want to keep your mail on the server after you retrieved it,
    1.86 +set this to true. It is recommended that you also set <b>do_uidl</b>,
    1.87 +otherwise you will get the mail again each time you connect to the
    1.88 +server. Masqmail does not check any headers before it retrieves mail,
    1.89 +which may mark it as already fetched.  Note that this behaviour is
    1.90 +different to that of fetchmail. The default is false.</p>
    1.91 +</optdesc>
    1.92 +</option>
    1.93 +
    1.94 +<option>
    1.95 +<p><opt>do_uidl</opt> = <arg>boolean</arg></p>
    1.96 +<optdesc>
    1.97 +<p>If set, MasqMail keeps a list of unique IDs of mails already
    1.98 +fetched, so that they will not be retrieved again. Default is false.</p>
    1.99 +</optdesc>
   1.100 +</option>
   1.101 +
   1.102 +<option>
   1.103 +<p><opt>do_uidl_dele</opt> = <arg>boolean</arg></p>
   1.104 +<optdesc>
   1.105 +<p>If set, and <opt>do_uidl</opt> is also set, MasqMail sends a delete (DELE)
   1.106 +command to the server for each message uid in the uid listing at the
   1.107 +beginning of the session. This prevents mail to be left on the server if
   1.108 +masqmail gets interrupted during a session before it can send the QUIT
   1.109 +command to the server. Default is false.
   1.110 +</p>
   1.111 +</optdesc>
   1.112 +</option>
   1.113 +
   1.114 +<option>
   1.115 +<p><opt>max_size</opt> = <arg>numeric</arg></p>
   1.116 +<optdesc>
   1.117 +<p>If set to a value > 0, only messages smaller than this in bytes will be
   1.118 +retrieved. The default is 0.</p>
   1.119 +</optdesc>
   1.120 +</option>
   1.121 +
   1.122 +<option>
   1.123 +<p><opt>max_count</opt> = <arg>numeric</arg></p>
   1.124 +<optdesc>
   1.125 +<p>If set to a value > 0, only <opt>max_count</opt> messages will be retrieved.
   1.126 +The default is 0.</p>
   1.127 +</optdesc>
   1.128 +</option>
   1.129 +
   1.130 +<option>
   1.131 +<p><opt>wrapper</opt> = <arg>command</arg></p>
   1.132 +<optdesc>
   1.133 +<p>If set, instead of opening a connection to a remote server, <arg>command</arg> will
   1.134 +be called and all traffic will be piped to its
   1.135 +stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p>
   1.136 +<p>Example for ssl tunneling:</p>
   1.137 +<p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p>
   1.138 +</optdesc>
   1.139 +</option>
   1.140 +
   1.141 +</options>
   1.142 +
   1.143 +<section name = "Author">
   1.144 +<p>masqmail was written by Oliver Kurth
   1.145 +&lt;oku@masqmail.cx&gt;</p><p>You will find the newest version of
   1.146 +masqmail at <url href="http://masqmail.cx/masqmail/"/> or search for it
   1.147 +in freshmeat (<url href="http://www.freshmeat.net"/>). There is also a mailing list,
   1.148 +you will find information about it at masqmails main site.</p>
   1.149 +</section>
   1.150 +
   1.151 +<section name = "Bugs">
   1.152 +<p>You should report them to the mailing list.</p>
   1.153 +</section>
   1.154 +
   1.155 +<section name = "See also">
   1.156 +<p>
   1.157 +<manref name="masqmail" section="8" href="masqmail.8.html"/>, <manref name="masqmail.route" section="5" href="masqmail.route.5.html"/>, <manref name="masqmail.conf" section="5" href="masqmail.conf.5.html"/>
   1.158 +</p>
   1.159 +</section>
   1.160 +
   1.161 +<section name = "Comments">
   1.162 +<p>This man page was written using <manref name="xml2man" section="1"
   1.163 +href="http://masqmail.cx/xml2man/"/> by the same
   1.164 +author.</p>
   1.165 +</section>
   1.166 +
   1.167 +</manpage>
   1.168 +