[bfe245f] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[bfe245f] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY fetchmail-download-http "&sourceforge-dl;/fetchmail/fetchmail-&fetchmail-version;.tar.xz">
|
---|
[ae0f6ec0] | 8 | <!ENTITY fetchmail-download-ftp " ">
|
---|
[f81dfa79] | 9 | <!ENTITY fetchmail-md5sum "039b49a4f41f8544a51d82d2f4599dfc">
|
---|
| 10 | <!ENTITY fetchmail-size "1.3 MB">
|
---|
[afe4b852] | 11 | <!ENTITY fetchmail-buildsize "16 MB">
|
---|
[d8a1fe81] | 12 | <!ENTITY fetchmail-time "0.1 SBU">
|
---|
[bfe245f] | 13 | ]>
|
---|
| 14 |
|
---|
[31784c8] | 15 | <sect1 id="fetchmail" xreflabel="fetchmail-&fetchmail-version;">
|
---|
[3bac165] | 16 | <?dbhtml filename="fetchmail.html"?>
|
---|
[481b3e8] | 17 |
|
---|
[3bac165] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[481b3e8] | 22 |
|
---|
[3bac165] | 23 | <title>Fetchmail-&fetchmail-version;</title>
|
---|
[481b3e8] | 24 |
|
---|
[3bac165] | 25 | <indexterm zone="fetchmail">
|
---|
| 26 | <primary sortas="a-Fetchmail">Fetchmail</primary>
|
---|
| 27 | </indexterm>
|
---|
[481b3e8] | 28 |
|
---|
[3bac165] | 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Fetchmail</title>
|
---|
[481b3e8] | 31 |
|
---|
[3bac165] | 32 | <para>The <application>Fetchmail</application> package contains a mail
|
---|
[876ad7f] | 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>
|
---|
[481b3e8] | 36 |
|
---|
[f81dfa79] | 37 | &lfs91_checked;
|
---|
[06f76d2c] | 38 |
|
---|
[3bac165] | 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>
|
---|
[481b3e8] | 60 |
|
---|
[3bac165] | 61 | <bridgehead renderas="sect3">Fetchmail Dependencies</bridgehead>
|
---|
[481b3e8] | 62 |
|
---|
[d92abe56] | 63 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 64 | <para role="recommended">
|
---|
[c48bc3ba] | 65 | a local MDA (<xref linkend="procmail"/>)
|
---|
| 66 | </para>
|
---|
[481b3e8] | 67 |
|
---|
[3bac165] | 68 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c48bc3ba] | 69 | <para role="optional">
|
---|
[afe4b852] | 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
|
---|
[6c61096] | 75 | <xref linkend="python2"/>, built after
|
---|
[afe4b852] | 76 | <xref linkend="tk"/>-->
|
---|
| 77 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>
|
---|
[c48bc3ba] | 78 | </para>
|
---|
[481b3e8] | 79 |
|
---|
[061ec9d] | 80 | <para condition="html" role="usernotes">User Notes:
|
---|
| 81 | <ulink url="&blfs-wiki;/fetchmail"/></para>
|
---|
| 82 |
|
---|
[3bac165] | 83 | </sect2>
|
---|
[481b3e8] | 84 |
|
---|
[3bac165] | 85 | <sect2 role="installation">
|
---|
| 86 | <title>Installation of Fetchmail</title>
|
---|
[481b3e8] | 87 |
|
---|
[afe4b852] | 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 |
|
---|
[481b3e8] | 97 | <para>Install <application>Fetchmail</application> by running the following
|
---|
[3bac165] | 98 | commands:</para>
|
---|
[481b3e8] | 99 |
|
---|
[afe4b852] | 100 | <screen><userinput>PYTHON=python3 \
|
---|
| 101 | ./configure --prefix=/usr \
|
---|
| 102 | --enable-fallback=procmail &&
|
---|
[46441976] | 103 | make</userinput></screen>
|
---|
| 104 |
|
---|
[afe4b852] | 105 | <para>
|
---|
| 106 | To test the results, issue: <command>make check</command>.
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[46441976] | 109 |
|
---|
| 110 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 111 |
|
---|
[afe4b852] | 112 | <screen role='root'><userinput>make install &&
|
---|
| 113 | chown -v fetchmail:nogroup /usr/bin/fetchmail</userinput></screen>
|
---|
[481b3e8] | 114 |
|
---|
[3bac165] | 115 | </sect2>
|
---|
[481b3e8] | 116 |
|
---|
[3bac165] | 117 | <sect2 role="commands">
|
---|
[e3353b3] | 118 | <title>Command Explanations</title>
|
---|
[481b3e8] | 119 |
|
---|
[afe4b852] | 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>
|
---|
[481b3e8] | 126 |
|
---|
[3bac165] | 127 | <para><parameter>--enable-fallback=procmail</parameter>: This tells
|
---|
| 128 | <application>Fetchmail</application> to hand incoming mail to
|
---|
[876ad7f] | 129 | <application>Procmail</application> for delivery, if the port 25 mail server is
|
---|
[3bac165] | 130 | not present or not responding.</para>
|
---|
[481b3e8] | 131 |
|
---|
[3bac165] | 132 | </sect2>
|
---|
[481b3e8] | 133 |
|
---|
[3bac165] | 134 | <sect2 role="configuration">
|
---|
| 135 | <title>Configuring Fetchmail</title>
|
---|
[481b3e8] | 136 |
|
---|
[3bac165] | 137 | <sect3 id="fetchmail-config">
|
---|
[e3353b3] | 138 | <title>Config Files</title>
|
---|
[481b3e8] | 139 |
|
---|
[3bac165] | 140 | <para><filename>~/.fetchmailrc</filename></para>
|
---|
[481b3e8] | 141 |
|
---|
[3bac165] | 142 | <indexterm zone="fetchmail fetchmail-config">
|
---|
| 143 | <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
|
---|
| 144 | </indexterm>
|
---|
[481b3e8] | 145 |
|
---|
[3bac165] | 146 | </sect3>
|
---|
[481b3e8] | 147 |
|
---|
[3bac165] | 148 | <sect3>
|
---|
| 149 | <title>Configuration Information</title>
|
---|
[481b3e8] | 150 |
|
---|
[3bac165] | 151 | <screen><userinput>cat > ~/.fetchmailrc << "EOF"
|
---|
[afe4b852] | 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
|
---|
[bfe245f] | 157 | set no bouncemail
|
---|
[afe4b852] | 158 | # You probably want to set your local username as the postmaster
|
---|
| 159 | set postmaster <replaceable><username></replaceable>
|
---|
[481b3e8] | 160 |
|
---|
| 161 | poll SERVERNAME :
|
---|
[afe4b852] | 162 | user <replaceable><isp_username></replaceable> pass <replaceable><password></replaceable>;
|
---|
[3bac165] | 163 | mda "/usr/bin/procmail -f %F -d %T";</literal>
|
---|
| 164 | EOF
|
---|
[481b3e8] | 165 |
|
---|
[afe4b852] | 166 | touch ~/fetchmail.log &&
|
---|
[e3353b3] | 167 | chmod -v 0600 ~/.fetchmailrc</userinput></screen>
|
---|
[481b3e8] | 168 |
|
---|
| 169 | <para>This is an example configuration that should suffice for most people.
|
---|
[3bac165] | 170 | You can add as many users and servers as you need using the same syntax.</para>
|
---|
[481b3e8] | 171 |
|
---|
[c48bc3ba] | 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>
|
---|
[481b3e8] | 176 |
|
---|
[f684538] | 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 |
|
---|
[3bac165] | 183 | </sect3>
|
---|
[481b3e8] | 184 |
|
---|
[3bac165] | 185 | </sect2>
|
---|
[481b3e8] | 186 |
|
---|
[3bac165] | 187 | <sect2 role="content">
|
---|
| 188 | <title>Contents</title>
|
---|
[481b3e8] | 189 |
|
---|
[3bac165] | 190 | <segmentedlist>
|
---|
[832d359b] | 191 | <segtitle>Installed Programs</segtitle>
|
---|
[3bac165] | 192 | <segtitle>Installed Libraries</segtitle>
|
---|
| 193 | <segtitle>Installed Directories</segtitle>
|
---|
[481b3e8] | 194 |
|
---|
[3bac165] | 195 | <seglistitem>
|
---|
| 196 | <seg>fetchmail and fetchmailconf</seg>
|
---|
| 197 | <seg>None</seg>
|
---|
[46441976] | 198 | <seg>None</seg>
|
---|
[3bac165] | 199 | </seglistitem>
|
---|
| 200 | </segmentedlist>
|
---|
[481b3e8] | 201 |
|
---|
[3bac165] | 202 | <variablelist>
|
---|
| 203 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 204 | <?dbfo list-presentation="list"?>
|
---|
| 205 | <?dbhtml list-presentation="table"?>
|
---|
[481b3e8] | 206 |
|
---|
[3bac165] | 207 | <varlistentry id="fetchmail-prog">
|
---|
| 208 | <term><command>fetchmail</command></term>
|
---|
| 209 | <listitem>
|
---|
[876ad7f] | 210 | <para>when executed as a user, this will source
|
---|
| 211 | <filename>~/.fetchmailrc</filename> and download the appropriate mail.
|
---|
| 212 | </para>
|
---|
[3bac165] | 213 | <indexterm zone="fetchmail fetchmail-prog">
|
---|
| 214 | <primary sortas="b-fetchmail">fetchmail</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
[481b3e8] | 218 |
|
---|
[3bac165] | 219 | <varlistentry id="fetchmailconf">
|
---|
| 220 | <term><command>fetchmailconf</command></term>
|
---|
| 221 | <listitem>
|
---|
[afe4b852] | 222 | <!-- keep detailed description commented pending any feedback
|
---|
| 223 | <para>was intended to assist you in setting up and editing a
|
---|
[876ad7f] | 224 | <filename>~/.fetchmailrc</filename> configuration file, by using
|
---|
[afe4b852] | 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>
|
---|
[3bac165] | 235 | <indexterm zone="fetchmail fetchmailconf">
|
---|
| 236 | <primary sortas="b-fetchmailconf">fetchmailconf</primary>
|
---|
| 237 | </indexterm>
|
---|
| 238 | </listitem>
|
---|
| 239 | </varlistentry>
|
---|
[481b3e8] | 240 |
|
---|
[3bac165] | 241 | </variablelist>
|
---|
[481b3e8] | 242 |
|
---|
[3bac165] | 243 | </sect2>
|
---|
[481b3e8] | 244 |
|
---|
[f45b1953] | 245 | </sect1>
|
---|