1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/man/masqmail.get.5	Sat May 29 22:07:07 2010 +0200
     1.3 @@ -0,0 +1,134 @@
     1.4 +.TH masqmail.get 5 2010-05-07 masqmail-0.2.22 "File Formats"
     1.5 +
     1.6 +.SH NAME
     1.7 +masqmail.get \- masqmail get configuration file
     1.8 +
     1.9 +
    1.10 +.SH DESCRIPTION
    1.11 + 
    1.12 +This man page describes the options available for the masqmail get configuration.
    1.13 +
    1.14 +
    1.15 +.SH OPTIONS
    1.16 +
    1.17 +.TP
    1.18 +\fBprotocol\fR = \fIstring\fR
    1.19 +
    1.20 +The protocol with which you retrieve your mail.
    1.21 +Currently only `pop3' and `apop' are supported.
    1.22 +There is no default.
    1.23 +
    1.24 +.TP
    1.25 +\fBserver\fR = \fIstring\fR
    1.26 +
    1.27 +The server you get your mail from.
    1.28 +
    1.29 +.TP
    1.30 +\fBresolve_list\fR = \fIlist\fR
    1.31 +
    1.32 +Specify the method how the domain of the server is resolved.
    1.33 +Possible values are dns_mx, dns_a, byname.
    1.34 +For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
    1.35 +these will be tried each in order
    1.36 +(lowest preference value first, equal preference values in random order).
    1.37 +For `dns_a', the domain is assumed to be an A pointer.
    1.38 +For `byname', the library function \fBgethostbyname(3)\fR will be used.
    1.39 +
    1.40 +The default is "dns_a;byname".
    1.41 +It does not make much sense here to use `dns_mx'.
    1.42 +
    1.43 +.TP
    1.44 +\fBuser\fR = \fIstring\fR
    1.45 +
    1.46 +Your login name.
    1.47 +
    1.48 +.TP
    1.49 +\fBpass\fR = \fIstring\fR
    1.50 +
    1.51 +Your password.
    1.52 +
    1.53 +.TP
    1.54 +\fBaddress\fR = \fIaddress\fR
    1.55 +
    1.56 +The address where the retrieved mail should be sent to.
    1.57 +It can be any address, but you probably want to set this to a local address on your LAN.
    1.58 +
    1.59 +.TP
    1.60 +\fBreturn_path\fR = \fIaddress\fR
    1.61 +
    1.62 +If set, masqmail sets the return path to this address.
    1.63 +Bounces generated during further delivery will be sent to this address.
    1.64 +If unset, masqmail looks for the Return-Path: header in the mail,
    1.65 +if this does not exist it uses the From: address and if this fails, postmaster will be used.
    1.66 +
    1.67 +It is in most cases not useful to set this to the same address as the `address'
    1.68 +option as this may generate multiple bounces.
    1.69 +postmaster is recommended.
    1.70 +
    1.71 +.TP
    1.72 +\fBdo_keep\fR = \fIboolean\fR
    1.73 +
    1.74 +If you want to keep your mail on the server after you retrieved it, set this to true.
    1.75 +It is recommended that you also set do_uidl,
    1.76 +otherwise you will get the mail again each time you connect to the server.
    1.77 +Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched.
    1.78 +Note that this behaviour is different to that of fetchmail.
    1.79 +The default is false.
    1.80 +
    1.81 +.TP
    1.82 +\fBdo_uidl\fR = \fIboolean\fR
    1.83 +
    1.84 +If set, masqmail keeps a list of unique IDs of mails already fetched,
    1.85 +so that they will not be retrieved again.
    1.86 +Default is false.
    1.87 +
    1.88 +.TP
    1.89 +\fBdo_uidl_dele\fR = \fIboolean\fR
    1.90 +
    1.91 +If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command
    1.92 +to the server for each message uid in the uid listing at the beginning of the session.
    1.93 +This prevents mail to be left on the server if masqmail gets interrupted during
    1.94 +a session before it can send the QUIT command to the server.
    1.95 +Default is false.
    1.96 +
    1.97 +.TP
    1.98 +\fBmax_size\fR = \fInumeric\fR
    1.99 +
   1.100 +If set to a value > 0, only messages smaller than this in bytes will be retrieved.
   1.101 +The default is 0.
   1.102 +
   1.103 +.TP
   1.104 +\fBmax_count\fR = \fInumeric\fR
   1.105 +
   1.106 +If set to a value > 0, only \fBmax_count\fR messages will be retrieved.
   1.107 +The default is 0.
   1.108 +
   1.109 +.TP
   1.110 +\fBwrapper\fR = \fIcommand\fR
   1.111 +
   1.112 +If set, instead of opening a connection to a remote server,
   1.113 +\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
   1.114 +Purpose is to tunnel ip traffic, e.g. for ssl.
   1.115 +
   1.116 +Example for ssl tunneling:
   1.117 +
   1.118 +wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
   1.119 +
   1.120 +
   1.121 +.SH AUTHOR
   1.122 +
   1.123 +Masqmail was written by Oliver Kurth.
   1.124 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.125 +
   1.126 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   1.127 +There is also a mailing list, you will find information about it at masqmail's main site.
   1.128 +
   1.129 +
   1.130 +.SH BUGS
   1.131 +
   1.132 +Please report bugs to the mailing list.
   1.133 +
   1.134 +
   1.135 +.SH SEE ALSO
   1.136 +
   1.137 +\fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR