masqmail-0.2

annotate man/masqmail.get.5 @ 186:4714f093fc77

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