masqmail-0.2

annotate man/masqmail.get.5 @ 60:e119cee8d493

find changesets by author, revision, files, or words in the commit message
tiny improvement in usage message
author meillo@marmaro.de
date Sat, 29 May 2010 22:57:17 +0200
parents 03817f849106
children e01fed4846e4
rev   line source
meillo@42 1 .TH masqmail.get 5 2010-05-07 masqmail-0.2.22 "File Formats"
meillo@34 2
meillo@0 3 .SH NAME
meillo@0 4 masqmail.get \- masqmail get configuration file
meillo@34 5
meillo@34 6
meillo@0 7 .SH DESCRIPTION
meillo@0 8
meillo@0 9 This man page describes the options available for the masqmail get configuration.
meillo@0 10
meillo@34 11
meillo@0 12 .SH OPTIONS
meillo@34 13
meillo@0 14 .TP
meillo@34 15 \fBprotocol\fR = \fIstring\fR
meillo@0 16
meillo@34 17 The protocol with which you retrieve your mail.
meillo@34 18 Currently only `pop3' and `apop' are supported.
meillo@34 19 There is no default.
meillo@0 20
meillo@0 21 .TP
meillo@34 22 \fBserver\fR = \fIstring\fR
meillo@0 23
meillo@0 24 The server you get your mail from.
meillo@34 25
meillo@0 26 .TP
meillo@34 27 \fBresolve_list\fR = \fIlist\fR
meillo@0 28
meillo@34 29 Specify the method how the domain of the server is resolved.
meillo@34 30 Possible values are dns_mx, dns_a, byname.
meillo@34 31 For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
meillo@34 32 these will be tried each in order
meillo@34 33 (lowest preference value first, equal preference values in random order).
meillo@34 34 For `dns_a', the domain is assumed to be an A pointer.
meillo@34 35 For `byname', the library function \fBgethostbyname(3)\fR will be used.
meillo@0 36
meillo@34 37 The default is "dns_a;byname".
meillo@34 38 It does not make much sense here to use `dns_mx'.
meillo@0 39
meillo@0 40 .TP
meillo@34 41 \fBuser\fR = \fIstring\fR
meillo@0 42
meillo@0 43 Your login name.
meillo@34 44
meillo@0 45 .TP
meillo@34 46 \fBpass\fR = \fIstring\fR
meillo@0 47
meillo@0 48 Your password.
meillo@34 49
meillo@0 50 .TP
meillo@34 51 \fBaddress\fR = \fIaddress\fR
meillo@0 52
meillo@34 53 The address where the retrieved mail should be sent to.
meillo@34 54 It can be any address, but you probably want to set this to a local address on your LAN.
meillo@0 55
meillo@0 56 .TP
meillo@34 57 \fBreturn_path\fR = \fIaddress\fR
meillo@0 58
meillo@34 59 If set, masqmail sets the return path to this address.
meillo@34 60 Bounces generated during further delivery will be sent to this address.
meillo@34 61 If unset, masqmail looks for the Return-Path: header in the mail,
meillo@34 62 if this does not exist it uses the From: address and if this fails, postmaster will be used.
meillo@0 63
meillo@34 64 It is in most cases not useful to set this to the same address as the `address'
meillo@34 65 option as this may generate multiple bounces.
meillo@34 66 postmaster is recommended.
meillo@0 67
meillo@0 68 .TP
meillo@34 69 \fBdo_keep\fR = \fIboolean\fR
meillo@0 70
meillo@34 71 If you want to keep your mail on the server after you retrieved it, set this to true.
meillo@34 72 It is recommended that you also set do_uidl,
meillo@34 73 otherwise you will get the mail again each time you connect to the server.
meillo@34 74 Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched.
meillo@34 75 Note that this behaviour is different to that of fetchmail.
meillo@34 76 The default is false.
meillo@0 77
meillo@0 78 .TP
meillo@34 79 \fBdo_uidl\fR = \fIboolean\fR
meillo@0 80
meillo@34 81 If set, masqmail keeps a list of unique IDs of mails already fetched,
meillo@34 82 so that they will not be retrieved again.
meillo@34 83 Default is false.
meillo@0 84
meillo@0 85 .TP
meillo@34 86 \fBdo_uidl_dele\fR = \fIboolean\fR
meillo@0 87
meillo@34 88 If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command
meillo@34 89 to the server for each message uid in the uid listing at the beginning of the session.
meillo@34 90 This prevents mail to be left on the server if masqmail gets interrupted during
meillo@34 91 a session before it can send the QUIT command to the server.
meillo@34 92 Default is false.
meillo@0 93
meillo@0 94 .TP
meillo@34 95 \fBmax_size\fR = \fInumeric\fR
meillo@0 96
meillo@34 97 If set to a value > 0, only messages smaller than this in bytes will be retrieved.
meillo@34 98 The default is 0.
meillo@0 99
meillo@0 100 .TP
meillo@34 101 \fBmax_count\fR = \fInumeric\fR
meillo@0 102
meillo@34 103 If set to a value > 0, only \fBmax_count\fR messages will be retrieved.
meillo@34 104 The default is 0.
meillo@0 105
meillo@0 106 .TP
meillo@34 107 \fBwrapper\fR = \fIcommand\fR
meillo@0 108
meillo@34 109 If set, instead of opening a connection to a remote server,
meillo@34 110 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
meillo@34 111 Purpose is to tunnel ip traffic, e.g. for ssl.
meillo@0 112
meillo@0 113 Example for ssl tunneling:
meillo@0 114
meillo@16 115 wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
meillo@34 116
meillo@34 117
meillo@0 118 .SH AUTHOR
meillo@0 119
meillo@34 120 Masqmail was written by Oliver Kurth.
meillo@34 121 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0 122
meillo@34 123 You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
meillo@26 124 There is also a mailing list, you will find information about it at masqmail's main site.
meillo@0 125
meillo@34 126
meillo@0 127 .SH BUGS
meillo@0 128
meillo@34 129 Please report bugs to the mailing list.
meillo@34 130
meillo@0 131
meillo@0 132 .SH SEE ALSO
meillo@0 133
meillo@34 134 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR