source: networking/mailnews/fetchmail.xml

trunk
Last change on this file was aaab0a4e, checked in by Ken Moffat <ken@…>, 5 weeks ago

Package updates:

fetchmail-6.4.22,
mutt-2.1.3.

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