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