[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 " ">
|
---|
[2b254ea9] | 9 | <!ENTITY fetchmail-md5sum "460c3e31227f2d4652c067db64fdc64c">
|
---|
[6b21b3dd] | 10 | <!ENTITY fetchmail-size "1.3 MB">
|
---|
| 11 | <!ENTITY fetchmail-buildsize "17 MB including tests">
|
---|
| 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 | <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 |
|
---|
[7c56ece] | 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>
|
---|
[481b3e8] | 38 |
|
---|
[ce6806c] | 39 | &lfs101_checked;
|
---|
[06f76d2c] | 40 |
|
---|
[3bac165] | 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing='compact'>
|
---|
| 43 | <listitem>
|
---|
[7c56ece] | 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&fetchmail-download-http;"/>
|
---|
| 46 | </para>
|
---|
[3bac165] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[7c56ece] | 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&fetchmail-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
[3bac165] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[7c56ece] | 54 | <para>
|
---|
| 55 | Download MD5 sum: &fetchmail-md5sum;
|
---|
| 56 | </para>
|
---|
[3bac165] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[7c56ece] | 59 | <para>
|
---|
| 60 | Download size: &fetchmail-size;
|
---|
| 61 | </para>
|
---|
[3bac165] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[7c56ece] | 64 | <para>
|
---|
| 65 | Estimated disk space required: &fetchmail-buildsize;
|
---|
| 66 | </para>
|
---|
[3bac165] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[7c56ece] | 69 | <para>
|
---|
| 70 | Estimated build time: &fetchmail-time;
|
---|
| 71 | </para>
|
---|
[3bac165] | 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
[481b3e8] | 74 |
|
---|
[3bac165] | 75 | <bridgehead renderas="sect3">Fetchmail Dependencies</bridgehead>
|
---|
[481b3e8] | 76 |
|
---|
[d92abe56] | 77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 78 | <para role="recommended">
|
---|
[c48bc3ba] | 79 | a local MDA (<xref linkend="procmail"/>)
|
---|
| 80 | </para>
|
---|
[481b3e8] | 81 |
|
---|
[3bac165] | 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c48bc3ba] | 83 | <para role="optional">
|
---|
[afe4b852] | 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 -->
|
---|
[c9194c7] | 87 | <xref linkend="mitkrb"/>, and
|
---|
[7c56ece] | 88 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">
|
---|
| 89 | libgssapi
|
---|
| 90 | </ulink>
|
---|
[c48bc3ba] | 91 | </para>
|
---|
[481b3e8] | 92 |
|
---|
[c9194c7] | 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 |
|
---|
[061ec9d] | 100 | <para condition="html" role="usernotes">User Notes:
|
---|
| 101 | <ulink url="&blfs-wiki;/fetchmail"/></para>
|
---|
| 102 |
|
---|
[3bac165] | 103 | </sect2>
|
---|
[481b3e8] | 104 |
|
---|
[3bac165] | 105 | <sect2 role="installation">
|
---|
| 106 | <title>Installation of Fetchmail</title>
|
---|
[481b3e8] | 107 |
|
---|
[afe4b852] | 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 |
|
---|
[7c56ece] | 117 | <para>
|
---|
| 118 | Install <application>Fetchmail</application> by running the following
|
---|
| 119 | commands:
|
---|
| 120 | </para>
|
---|
[481b3e8] | 121 |
|
---|
[afe4b852] | 122 | <screen><userinput>PYTHON=python3 \
|
---|
| 123 | ./configure --prefix=/usr \
|
---|
| 124 | --enable-fallback=procmail &&
|
---|
[46441976] | 125 | make</userinput></screen>
|
---|
| 126 |
|
---|
[afe4b852] | 127 | <para>
|
---|
| 128 | To test the results, issue: <command>make check</command>.
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
[46441976] | 131 |
|
---|
[7c56ece] | 132 | <para>
|
---|
| 133 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 134 | </para>
|
---|
[46441976] | 135 |
|
---|
[afe4b852] | 136 | <screen role='root'><userinput>make install &&
|
---|
| 137 | chown -v fetchmail:nogroup /usr/bin/fetchmail</userinput></screen>
|
---|
[481b3e8] | 138 |
|
---|
[3bac165] | 139 | </sect2>
|
---|
[481b3e8] | 140 |
|
---|
[3bac165] | 141 | <sect2 role="commands">
|
---|
[e3353b3] | 142 | <title>Command Explanations</title>
|
---|
[481b3e8] | 143 |
|
---|
[afe4b852] | 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>
|
---|
[481b3e8] | 150 |
|
---|
[7c56ece] | 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>
|
---|
[481b3e8] | 157 |
|
---|
[3bac165] | 158 | </sect2>
|
---|
[481b3e8] | 159 |
|
---|
[3bac165] | 160 | <sect2 role="configuration">
|
---|
| 161 | <title>Configuring Fetchmail</title>
|
---|
[481b3e8] | 162 |
|
---|
[3bac165] | 163 | <sect3 id="fetchmail-config">
|
---|
[e3353b3] | 164 | <title>Config Files</title>
|
---|
[481b3e8] | 165 |
|
---|
[7c56ece] | 166 | <para>
|
---|
| 167 | <filename>~/.fetchmailrc</filename>
|
---|
| 168 | </para>
|
---|
[481b3e8] | 169 |
|
---|
[3bac165] | 170 | <indexterm zone="fetchmail fetchmail-config">
|
---|
| 171 | <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
|
---|
| 172 | </indexterm>
|
---|
[481b3e8] | 173 |
|
---|
[3bac165] | 174 | </sect3>
|
---|
[481b3e8] | 175 |
|
---|
[3bac165] | 176 | <sect3>
|
---|
| 177 | <title>Configuration Information</title>
|
---|
[481b3e8] | 178 |
|
---|
[3bac165] | 179 | <screen><userinput>cat > ~/.fetchmailrc << "EOF"
|
---|
[afe4b852] | 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.
|
---|
| 184 | set logfile fetchmail.log
|
---|
[bfe245f] | 185 | set no bouncemail
|
---|
[afe4b852] | 186 | # You probably want to set your local username as the postmaster
|
---|
| 187 | set postmaster <replaceable><username></replaceable>
|
---|
[481b3e8] | 188 |
|
---|
| 189 | poll SERVERNAME :
|
---|
[afe4b852] | 190 | user <replaceable><isp_username></replaceable> pass <replaceable><password></replaceable>;
|
---|
[3bac165] | 191 | mda "/usr/bin/procmail -f %F -d %T";</literal>
|
---|
| 192 | EOF
|
---|
[481b3e8] | 193 |
|
---|
[afe4b852] | 194 | touch ~/fetchmail.log &&
|
---|
[e3353b3] | 195 | chmod -v 0600 ~/.fetchmailrc</userinput></screen>
|
---|
[481b3e8] | 196 |
|
---|
[7c56ece] | 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>
|
---|
[f684538] | 217 |
|
---|
[3bac165] | 218 | </sect3>
|
---|
[481b3e8] | 219 |
|
---|
[3bac165] | 220 | </sect2>
|
---|
[481b3e8] | 221 |
|
---|
[3bac165] | 222 | <sect2 role="content">
|
---|
| 223 | <title>Contents</title>
|
---|
[481b3e8] | 224 |
|
---|
[3bac165] | 225 | <segmentedlist>
|
---|
[832d359b] | 226 | <segtitle>Installed Programs</segtitle>
|
---|
[3bac165] | 227 | <segtitle>Installed Libraries</segtitle>
|
---|
| 228 | <segtitle>Installed Directories</segtitle>
|
---|
[481b3e8] | 229 |
|
---|
[3bac165] | 230 | <seglistitem>
|
---|
| 231 | <seg>fetchmail and fetchmailconf</seg>
|
---|
| 232 | <seg>None</seg>
|
---|
[46441976] | 233 | <seg>None</seg>
|
---|
[3bac165] | 234 | </seglistitem>
|
---|
| 235 | </segmentedlist>
|
---|
[481b3e8] | 236 |
|
---|
[3bac165] | 237 | <variablelist>
|
---|
| 238 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 239 | <?dbfo list-presentation="list"?>
|
---|
| 240 | <?dbhtml list-presentation="table"?>
|
---|
[481b3e8] | 241 |
|
---|
[3bac165] | 242 | <varlistentry id="fetchmail-prog">
|
---|
| 243 | <term><command>fetchmail</command></term>
|
---|
| 244 | <listitem>
|
---|
[7c56ece] | 245 | <para>
|
---|
| 246 | when executed as a user, this will source
|
---|
| 247 | <filename>~/.fetchmailrc</filename> and download the appropriate
|
---|
[4c24eb0a] | 248 | mail
|
---|
[876ad7f] | 249 | </para>
|
---|
[3bac165] | 250 | <indexterm zone="fetchmail fetchmail-prog">
|
---|
| 251 | <primary sortas="b-fetchmail">fetchmail</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
[481b3e8] | 255 |
|
---|
[3bac165] | 256 | <varlistentry id="fetchmailconf">
|
---|
| 257 | <term><command>fetchmailconf</command></term>
|
---|
| 258 | <listitem>
|
---|
[7c56ece] | 259 | <para>
|
---|
[c9194c7] | 260 | is intended to assist you in setting up and editing a
|
---|
[7c56ece] | 261 | <filename>~/.fetchmailrc</filename> configuration file, by using
|
---|
| 262 | a <application>Tk</application> GUI interface. It is written for
|
---|
[c9194c7] | 263 | <application>Python</application> and the Tkinter module but is
|
---|
| 264 | labelled with a WARNING that it needs to be updated
|
---|
[4c24eb0a] | 265 | for fetchmail 6.4's SSL options and other recent new options
|
---|
[c9194c7] | 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.
|
---|
[afe4b852] | 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.
|
---|
[c9194c7] | 274 | </para>-->
|
---|
[3bac165] | 275 | <indexterm zone="fetchmail fetchmailconf">
|
---|
| 276 | <primary sortas="b-fetchmailconf">fetchmailconf</primary>
|
---|
| 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
| 279 | </varlistentry>
|
---|
[481b3e8] | 280 |
|
---|
[3bac165] | 281 | </variablelist>
|
---|
[481b3e8] | 282 |
|
---|
[3bac165] | 283 | </sect2>
|
---|
[481b3e8] | 284 |
|
---|
[f45b1953] | 285 | </sect1>
|
---|