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