diff man/masqmail.get.5 @ 57:ed34413652fc

moved man pages from docs/ to man/
author meillo@marmaro.de
date Sat, 29 May 2010 22:07:07 +0200
parents docs/masqmail.get.5@03817f849106
children e01fed4846e4
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/masqmail.get.5	Sat May 29 22:07:07 2010 +0200
@@ -0,0 +1,134 @@
+.TH masqmail.get 5 2010-05-07 masqmail-0.2.22 "File Formats"
+
+.SH NAME
+masqmail.get \- masqmail get configuration file
+
+
+.SH DESCRIPTION
+ 
+This man page describes the options available for the masqmail get configuration.
+
+
+.SH OPTIONS
+
+.TP
+\fBprotocol\fR = \fIstring\fR
+
+The protocol with which you retrieve your mail.
+Currently only `pop3' and `apop' are supported.
+There is no default.
+
+.TP
+\fBserver\fR = \fIstring\fR
+
+The server you get your mail from.
+
+.TP
+\fBresolve_list\fR = \fIlist\fR
+
+Specify the method how the domain of the server is resolved.
+Possible values are dns_mx, dns_a, byname.
+For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
+these will be tried each in order
+(lowest preference value first, equal preference values in random order).
+For `dns_a', the domain is assumed to be an A pointer.
+For `byname', the library function \fBgethostbyname(3)\fR will be used.
+
+The default is "dns_a;byname".
+It does not make much sense here to use `dns_mx'.
+
+.TP
+\fBuser\fR = \fIstring\fR
+
+Your login name.
+
+.TP
+\fBpass\fR = \fIstring\fR
+
+Your password.
+
+.TP
+\fBaddress\fR = \fIaddress\fR
+
+The address where the retrieved mail should be sent to.
+It can be any address, but you probably want to set this to a local address on your LAN.
+
+.TP
+\fBreturn_path\fR = \fIaddress\fR
+
+If set, masqmail sets the return path to this address.
+Bounces generated during further delivery will be sent to this address.
+If unset, masqmail looks for the Return-Path: header in the mail,
+if this does not exist it uses the From: address and if this fails, postmaster will be used.
+
+It is in most cases not useful to set this to the same address as the `address'
+option as this may generate multiple bounces.
+postmaster is recommended.
+
+.TP
+\fBdo_keep\fR = \fIboolean\fR
+
+If you want to keep your mail on the server after you retrieved it, set this to true.
+It is recommended that you also set do_uidl,
+otherwise you will get the mail again each time you connect to the server.
+Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched.
+Note that this behaviour is different to that of fetchmail.
+The default is false.
+
+.TP
+\fBdo_uidl\fR = \fIboolean\fR
+
+If set, masqmail keeps a list of unique IDs of mails already fetched,
+so that they will not be retrieved again.
+Default is false.
+
+.TP
+\fBdo_uidl_dele\fR = \fIboolean\fR
+
+If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command
+to the server for each message uid in the uid listing at the beginning of the session.
+This prevents mail to be left on the server if masqmail gets interrupted during
+a session before it can send the QUIT command to the server.
+Default is false.
+
+.TP
+\fBmax_size\fR = \fInumeric\fR
+
+If set to a value > 0, only messages smaller than this in bytes will be retrieved.
+The default is 0.
+
+.TP
+\fBmax_count\fR = \fInumeric\fR
+
+If set to a value > 0, only \fBmax_count\fR messages will be retrieved.
+The default is 0.
+
+.TP
+\fBwrapper\fR = \fIcommand\fR
+
+If set, instead of opening a connection to a remote server,
+\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
+Purpose is to tunnel ip traffic, e.g. for ssl.
+
+Example for ssl tunneling:
+
+wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
+
+
+.SH AUTHOR
+
+Masqmail was written by Oliver Kurth.
+It is now maintained by Markus Schnalke <meillo@marmaro.de>.
+
+You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
+There is also a mailing list, you will find information about it at masqmail's main site.
+
+
+.SH BUGS
+
+Please report bugs to the mailing list.
+
+
+.SH SEE ALSO
+
+\fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR