[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 " ">
|
---|
[7f142f7] | 9 | <!ENTITY fetchmail-md5sum "091dcd5462f205dbc0597e7ad73d3e15">
|
---|
[6b21b3dd] | 10 | <!ENTITY fetchmail-size "1.3 MB">
|
---|
[7f142f7] | 11 | <!ENTITY fetchmail-buildsize "16 MB including tests">
|
---|
[6b21b3dd] | 12 | <!ENTITY fetchmail-time "0.1 SBU including tests">
|
---|
[bfe245f] | 13 | ]>
|
---|
| 14 |
|
---|
[31784c8] | 15 | <sect1 id="fetchmail" xreflabel="fetchmail-&fetchmail-version;">
|
---|
[3bac165] | 16 | <?dbhtml filename="fetchmail.html"?>
|
---|
[481b3e8] | 17 |
|
---|
[3bac165] | 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
[481b3e8] | 21 |
|
---|
[3bac165] | 22 | <title>Fetchmail-&fetchmail-version;</title>
|
---|
[481b3e8] | 23 |
|
---|
[3bac165] | 24 | <indexterm zone="fetchmail">
|
---|
| 25 | <primary sortas="a-Fetchmail">Fetchmail</primary>
|
---|
| 26 | </indexterm>
|
---|
[481b3e8] | 27 |
|
---|
[3bac165] | 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Fetchmail</title>
|
---|
[481b3e8] | 30 |
|
---|
[7c56ece] | 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>
|
---|
[481b3e8] | 37 |
|
---|
[ba716181] | 38 | &lfs110_checked;
|
---|
[06f76d2c] | 39 |
|
---|
[3bac165] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing='compact'>
|
---|
| 42 | <listitem>
|
---|
[7c56ece] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&fetchmail-download-http;"/>
|
---|
| 45 | </para>
|
---|
[3bac165] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[7c56ece] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&fetchmail-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[3bac165] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[7c56ece] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &fetchmail-md5sum;
|
---|
| 55 | </para>
|
---|
[3bac165] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[7c56ece] | 58 | <para>
|
---|
| 59 | Download size: &fetchmail-size;
|
---|
| 60 | </para>
|
---|
[3bac165] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[7c56ece] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &fetchmail-buildsize;
|
---|
| 65 | </para>
|
---|
[3bac165] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[7c56ece] | 68 | <para>
|
---|
| 69 | Estimated build time: &fetchmail-time;
|
---|
| 70 | </para>
|
---|
[3bac165] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
[481b3e8] | 73 |
|
---|
[3bac165] | 74 | <bridgehead renderas="sect3">Fetchmail Dependencies</bridgehead>
|
---|
[481b3e8] | 75 |
|
---|
[d92abe56] | 76 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 77 | <para role="recommended">
|
---|
[c48bc3ba] | 78 | a local MDA (<xref linkend="procmail"/>)
|
---|
| 79 | </para>
|
---|
[481b3e8] | 80 |
|
---|
[3bac165] | 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c48bc3ba] | 82 | <para role="optional">
|
---|
[afe4b852] | 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 -->
|
---|
[4f9e6ae5] | 86 | <xref linkend="mitkrb"/> and
|
---|
| 87 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>
|
---|
[c48bc3ba] | 88 | </para>
|
---|
[481b3e8] | 89 |
|
---|
[c9194c7] | 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 |
|
---|
[061ec9d] | 97 | <para condition="html" role="usernotes">User Notes:
|
---|
| 98 | <ulink url="&blfs-wiki;/fetchmail"/></para>
|
---|
| 99 |
|
---|
[3bac165] | 100 | </sect2>
|
---|
[481b3e8] | 101 |
|
---|
[3bac165] | 102 | <sect2 role="installation">
|
---|
| 103 | <title>Installation of Fetchmail</title>
|
---|
[481b3e8] | 104 |
|
---|
[afe4b852] | 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 |
|
---|
[7c56ece] | 114 | <para>
|
---|
| 115 | Install <application>Fetchmail</application> by running the following
|
---|
| 116 | commands:
|
---|
| 117 | </para>
|
---|
[481b3e8] | 118 |
|
---|
[afe4b852] | 119 | <screen><userinput>PYTHON=python3 \
|
---|
| 120 | ./configure --prefix=/usr \
|
---|
[4f9e6ae5] | 121 | --enable-fallback=procmail &&
|
---|
[46441976] | 122 | make</userinput></screen>
|
---|
| 123 |
|
---|
[afe4b852] | 124 | <para>
|
---|
| 125 | To test the results, issue: <command>make check</command>.
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
[46441976] | 128 |
|
---|
[7c56ece] | 129 | <para>
|
---|
| 130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 131 | </para>
|
---|
[46441976] | 132 |
|
---|
[afe4b852] | 133 | <screen role='root'><userinput>make install &&
|
---|
| 134 | chown -v fetchmail:nogroup /usr/bin/fetchmail</userinput></screen>
|
---|
[481b3e8] | 135 |
|
---|
[3bac165] | 136 | </sect2>
|
---|
[481b3e8] | 137 |
|
---|
[3bac165] | 138 | <sect2 role="commands">
|
---|
[e3353b3] | 139 | <title>Command Explanations</title>
|
---|
[481b3e8] | 140 |
|
---|
[afe4b852] | 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>
|
---|
[481b3e8] | 147 |
|
---|
[7c56ece] | 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>
|
---|
[481b3e8] | 154 |
|
---|
[3bac165] | 155 | </sect2>
|
---|
[481b3e8] | 156 |
|
---|
[3bac165] | 157 | <sect2 role="configuration">
|
---|
| 158 | <title>Configuring Fetchmail</title>
|
---|
[481b3e8] | 159 |
|
---|
[3bac165] | 160 | <sect3 id="fetchmail-config">
|
---|
[e3353b3] | 161 | <title>Config Files</title>
|
---|
[481b3e8] | 162 |
|
---|
[7c56ece] | 163 | <para>
|
---|
| 164 | <filename>~/.fetchmailrc</filename>
|
---|
| 165 | </para>
|
---|
[481b3e8] | 166 |
|
---|
[3bac165] | 167 | <indexterm zone="fetchmail fetchmail-config">
|
---|
| 168 | <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
|
---|
| 169 | </indexterm>
|
---|
[481b3e8] | 170 |
|
---|
[3bac165] | 171 | </sect3>
|
---|
[481b3e8] | 172 |
|
---|
[3bac165] | 173 | <sect3>
|
---|
| 174 | <title>Configuration Information</title>
|
---|
[481b3e8] | 175 |
|
---|
[3bac165] | 176 | <screen><userinput>cat > ~/.fetchmailrc << "EOF"
|
---|
[afe4b852] | 177 | <literal>
|
---|
| 178 | # The logfile needs to exist when fetchmail is invoked, otherwise it will
|
---|
| 179 | # dump the details to the screen. As with all logs, you will need to rotate
|
---|
| 180 | # or clear it from time to time.
|
---|
| 181 | set logfile fetchmail.log
|
---|
[bfe245f] | 182 | set no bouncemail
|
---|
[afe4b852] | 183 | # You probably want to set your local username as the postmaster
|
---|
| 184 | set postmaster <replaceable><username></replaceable>
|
---|
[481b3e8] | 185 |
|
---|
| 186 | poll SERVERNAME :
|
---|
[afe4b852] | 187 | user <replaceable><isp_username></replaceable> pass <replaceable><password></replaceable>;
|
---|
[3bac165] | 188 | mda "/usr/bin/procmail -f %F -d %T";</literal>
|
---|
| 189 | EOF
|
---|
[481b3e8] | 190 |
|
---|
[afe4b852] | 191 | touch ~/fetchmail.log &&
|
---|
[e3353b3] | 192 | chmod -v 0600 ~/.fetchmailrc</userinput></screen>
|
---|
[481b3e8] | 193 |
|
---|
[7c56ece] | 194 | <para>
|
---|
| 195 | This is an example configuration that should suffice for most people.
|
---|
| 196 | You can add as many users and servers as you need using the same syntax.
|
---|
| 197 | </para>
|
---|
| 198 |
|
---|
| 199 | <para>
|
---|
| 200 | <command>man fetchmail</command>: Look for the section near the bottom
|
---|
| 201 | named <emphasis>CONFIGURATION EXAMPLES</emphasis>. It gives some quick
|
---|
| 202 | examples. There are countless other configuration options once you get
|
---|
| 203 | used to it.
|
---|
| 204 | </para>
|
---|
| 205 |
|
---|
| 206 | <para>
|
---|
| 207 | If you expect to receive very little mail you can invoke fetchmail
|
---|
| 208 | when you wish to receive any incoming mail. More commonly, it is either
|
---|
| 209 | invoked in daemon mode with the <literal>-d</literal> option either on
|
---|
| 210 | the command line, or in <filename>.fetchmailrc</filename> (see 'DAEMON
|
---|
| 211 | MODE' in man fetchmailconf), or alternatively it is invoked from a
|
---|
| 212 | cron job.
|
---|
| 213 | </para>
|
---|
[f684538] | 214 |
|
---|
[3bac165] | 215 | </sect3>
|
---|
[481b3e8] | 216 |
|
---|
[3bac165] | 217 | </sect2>
|
---|
[481b3e8] | 218 |
|
---|
[3bac165] | 219 | <sect2 role="content">
|
---|
| 220 | <title>Contents</title>
|
---|
[481b3e8] | 221 |
|
---|
[3bac165] | 222 | <segmentedlist>
|
---|
[832d359b] | 223 | <segtitle>Installed Programs</segtitle>
|
---|
[3bac165] | 224 | <segtitle>Installed Libraries</segtitle>
|
---|
| 225 | <segtitle>Installed Directories</segtitle>
|
---|
[481b3e8] | 226 |
|
---|
[3bac165] | 227 | <seglistitem>
|
---|
| 228 | <seg>fetchmail and fetchmailconf</seg>
|
---|
| 229 | <seg>None</seg>
|
---|
[46441976] | 230 | <seg>None</seg>
|
---|
[3bac165] | 231 | </seglistitem>
|
---|
| 232 | </segmentedlist>
|
---|
[481b3e8] | 233 |
|
---|
[3bac165] | 234 | <variablelist>
|
---|
| 235 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 236 | <?dbfo list-presentation="list"?>
|
---|
| 237 | <?dbhtml list-presentation="table"?>
|
---|
[481b3e8] | 238 |
|
---|
[3bac165] | 239 | <varlistentry id="fetchmail-prog">
|
---|
| 240 | <term><command>fetchmail</command></term>
|
---|
| 241 | <listitem>
|
---|
[7c56ece] | 242 | <para>
|
---|
| 243 | when executed as a user, this will source
|
---|
| 244 | <filename>~/.fetchmailrc</filename> and download the appropriate
|
---|
[4c24eb0a] | 245 | mail
|
---|
[876ad7f] | 246 | </para>
|
---|
[3bac165] | 247 | <indexterm zone="fetchmail fetchmail-prog">
|
---|
| 248 | <primary sortas="b-fetchmail">fetchmail</primary>
|
---|
| 249 | </indexterm>
|
---|
| 250 | </listitem>
|
---|
| 251 | </varlistentry>
|
---|
[481b3e8] | 252 |
|
---|
[3bac165] | 253 | <varlistentry id="fetchmailconf">
|
---|
| 254 | <term><command>fetchmailconf</command></term>
|
---|
| 255 | <listitem>
|
---|
[7c56ece] | 256 | <para>
|
---|
[c9194c7] | 257 | is intended to assist you in setting up and editing a
|
---|
[7c56ece] | 258 | <filename>~/.fetchmailrc</filename> configuration file, by using
|
---|
| 259 | a <application>Tk</application> GUI interface. It is written for
|
---|
[c9194c7] | 260 | <application>Python</application> and the Tkinter module but is
|
---|
| 261 | labelled with a WARNING that it needs to be updated
|
---|
[4c24eb0a] | 262 | for fetchmail 6.4's SSL options and other recent new options
|
---|
[c9194c7] | 263 | </para>
|
---|
| 264 | <!-- keep this description commented but fetchmailconf
|
---|
| 265 | has been updated in the last months (June 2020). It can use
|
---|
| 266 | Python 3, with the help of the "past" module.
|
---|
[afe4b852] | 267 | <para>
|
---|
| 268 | is an unmaintained GUI command to assist in creating a
|
---|
| 269 | <filename>~/.fetchmailrc</filename> configuration file and
|
---|
| 270 | should not be used.
|
---|
[c9194c7] | 271 | </para>-->
|
---|
[3bac165] | 272 | <indexterm zone="fetchmail fetchmailconf">
|
---|
| 273 | <primary sortas="b-fetchmailconf">fetchmailconf</primary>
|
---|
| 274 | </indexterm>
|
---|
| 275 | </listitem>
|
---|
| 276 | </varlistentry>
|
---|
[481b3e8] | 277 |
|
---|
[3bac165] | 278 | </variablelist>
|
---|
[481b3e8] | 279 |
|
---|
[3bac165] | 280 | </sect2>
|
---|
[481b3e8] | 281 |
|
---|
[f45b1953] | 282 | </sect1>
|
---|