source: networking/mailnews/fetchmail.xml@ 87aef465

11.0 lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 87aef465 was 87aef465, checked in by Tim Tassonis <stuff@…>, 7 months ago

Update to fetchmail-6.4.17.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24348 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 9.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY fetchmail-download-http "&sourceforge-dl;/fetchmail/fetchmail-&fetchmail-version;.tar.xz">
8 <!ENTITY fetchmail-download-ftp " ">
9 <!ENTITY fetchmail-md5sum "6c43fd064a8ae7b8f5c9815be71621df">
10 <!ENTITY fetchmail-size "1.3 MB">
11 <!ENTITY fetchmail-buildsize "14 MB including tests">
12 <!ENTITY fetchmail-time "0.1 SBU including tests">
13]>
14
15<sect1 id="fetchmail" xreflabel="fetchmail-&fetchmail-version;">
16 <?dbhtml filename="fetchmail.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Fetchmail-&fetchmail-version;</title>
24
25 <indexterm zone="fetchmail">
26 <primary sortas="a-Fetchmail">Fetchmail</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Fetchmail</title>
31
32 <para>
33 The <application>Fetchmail</application> package contains a mail
34 retrieval program. It retrieves mail from remote mail servers and
35 forwards it to the local (client) machine's delivery system, so it can
36 then be read by normal mail user agents.
37 </para>
38
39 &lfs101_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing='compact'>
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&fetchmail-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&fetchmail-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &fetchmail-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &fetchmail-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &fetchmail-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &fetchmail-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Fetchmail Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Recommended</bridgehead>
78 <para role="recommended">
79 a local MDA (<xref linkend="procmail"/>)
80 </para>
81
82 <bridgehead renderas="sect4">Optional</bridgehead>
83 <para role="optional">
84 <!-- hesiod was at ftp://athena-dist.mit.edu/pub/ATHENA/hesiod/ but that
85 is dead. Debian had 3.2.1, git hub has a very old 3.1.
86 libintl is part of gettext so enabled by default on LFS -->
87 <xref linkend="mitkrb"/>, and
88 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">
89 libgssapi
90 </ulink>
91 </para>
92
93 <bridgehead renderas="sect4">Optional (for running fetchmailconf)</bridgehead>
94 <para role="optional">
95 <xref linkend="python3"/>, built after
96 <xref linkend="tk"/>, with the
97 <ulink url="http://python-future.org/">py-future</ulink> package
98 </para>
99
100 <para condition="html" role="usernotes">User Notes:
101 <ulink url="&blfs-wiki;/fetchmail"/></para>
102
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of Fetchmail</title>
107
108 <para>
109 Create a dedicated user for the fetchmail program.
110 Issue the following commands as the
111 <systemitem class="username">root</systemitem> user:
112 </para>
113
114<screen role="root"><userinput>useradd -c "Fetchmail User" -d /dev/null -g nogroup \
115 -s /bin/false -u 38 fetchmail</userinput></screen>
116
117 <para>
118 Install <application>Fetchmail</application> by running the following
119 commands:
120 </para>
121
122<screen><userinput>PYTHON=python3 \
123./configure --prefix=/usr \
124 --enable-fallback=procmail &amp;&amp;
125make</userinput></screen>
126
127 <para>
128 To test the results, issue: <command>make check</command>.
129 </para>
130
131
132 <para>
133 Now, as the <systemitem class="username">root</systemitem> user:
134 </para>
135
136<screen role='root'><userinput>make install &amp;&amp;
137chown -v fetchmail:nogroup /usr/bin/fetchmail</userinput></screen>
138
139 </sect2>
140
141 <sect2 role="commands">
142 <title>Command Explanations</title>
143
144 <para>
145 <parameter>PYTHON=python3</parameter>: a version of Python is
146 <emphasis>required</emphasis>, but only used to install a module to allow
147 fetchmailconf to be run. That module is unmaintained and should not be
148 used.
149 </para>
150
151 <para>
152 <parameter>--enable-fallback=procmail</parameter>: This tells
153 <application>Fetchmail</application> to hand incoming mail to
154 <application>Procmail</application> for delivery, if the port 25 mail
155 server is not present or not responding.
156 </para>
157
158 </sect2>
159
160 <sect2 role="configuration">
161 <title>Configuring Fetchmail</title>
162
163 <sect3 id="fetchmail-config">
164 <title>Config Files</title>
165
166 <para>
167 <filename>~/.fetchmailrc</filename>
168 </para>
169
170 <indexterm zone="fetchmail fetchmail-config">
171 <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
172 </indexterm>
173
174 </sect3>
175
176 <sect3>
177 <title>Configuration Information</title>
178
179<screen><userinput>cat &gt; ~/.fetchmailrc &lt;&lt; "EOF"
180<literal>
181# The logfile needs to exist when fetchmail is invoked, otherwise it will
182# dump the details to the screen. As with all logs, you will need to rotate
183# or clear it from time to time.
184set logfile fetchmail.log
185set no bouncemail
186# You probably want to set your local username as the postmaster
187set postmaster <replaceable>&lt;username&gt;</replaceable>
188
189poll SERVERNAME :
190 user <replaceable>&lt;isp_username&gt;</replaceable> pass <replaceable>&lt;password&gt;</replaceable>;
191 mda "/usr/bin/procmail -f %F -d %T";</literal>
192EOF
193
194touch ~/fetchmail.log &amp;&amp;
195chmod -v 0600 ~/.fetchmailrc</userinput></screen>
196
197 <para>
198 This is an example configuration that should suffice for most people.
199 You can add as many users and servers as you need using the same syntax.
200 </para>
201
202 <para>
203 <command>man fetchmail</command>: Look for the section near the bottom
204 named <emphasis>CONFIGURATION EXAMPLES</emphasis>. It gives some quick
205 examples. There are countless other configuration options once you get
206 used to it.
207 </para>
208
209 <para>
210 If you expect to receive very little mail you can invoke fetchmail
211 when you wish to receive any incoming mail. More commonly, it is either
212 invoked in daemon mode with the <literal>-d</literal> option either on
213 the command line, or in <filename>.fetchmailrc</filename> (see 'DAEMON
214 MODE' in man fetchmailconf), or alternatively it is invoked from a
215 cron job.
216 </para>
217
218 </sect3>
219
220 </sect2>
221
222 <sect2 role="content">
223 <title>Contents</title>
224
225 <segmentedlist>
226 <segtitle>Installed Programs</segtitle>
227 <segtitle>Installed Libraries</segtitle>
228 <segtitle>Installed Directories</segtitle>
229
230 <seglistitem>
231 <seg>fetchmail and fetchmailconf</seg>
232 <seg>None</seg>
233 <seg>None</seg>
234 </seglistitem>
235 </segmentedlist>
236
237 <variablelist>
238 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
239 <?dbfo list-presentation="list"?>
240 <?dbhtml list-presentation="table"?>
241
242 <varlistentry id="fetchmail-prog">
243 <term><command>fetchmail</command></term>
244 <listitem>
245 <para>
246 when executed as a user, this will source
247 <filename>~/.fetchmailrc</filename> and download the appropriate
248 mail
249 </para>
250 <indexterm zone="fetchmail fetchmail-prog">
251 <primary sortas="b-fetchmail">fetchmail</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="fetchmailconf">
257 <term><command>fetchmailconf</command></term>
258 <listitem>
259 <para>
260 is intended to assist you in setting up and editing a
261 <filename>~/.fetchmailrc</filename> configuration file, by using
262 a <application>Tk</application> GUI interface. It is written for
263 <application>Python</application> and the Tkinter module but is
264 labelled with a WARNING that it needs to be updated
265 for fetchmail 6.4's SSL options and other recent new options
266 </para>
267 <!-- keep this description commented but fetchmailconf
268 has been updated in the last months (June 2020). It can use
269 Python 3, with the help of the "past" module.
270 <para>
271 is an unmaintained GUI command to assist in creating a
272 <filename>~/.fetchmailrc</filename> configuration file and
273 should not be used.
274 </para>-->
275 <indexterm zone="fetchmail fetchmailconf">
276 <primary sortas="b-fetchmailconf">fetchmailconf</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 </variablelist>
282
283 </sect2>
284
285</sect1>
Note: See TracBrowser for help on using the repository browser.