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