[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 " ">
|
---|
[0d900fe] | 9 | <!ENTITY fetchmail-md5sum "61db4f95af4f1a5f95e7ea632928d48d">
|
---|
[cb993ff] | 10 | <!ENTITY fetchmail-size "1.1 MB">
|
---|
[0d900fe] | 11 | <!ENTITY fetchmail-buildsize "15 MB including tests">
|
---|
[74d63dc] | 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 |
|
---|
| 18 |
|
---|
[3bac165] | 19 | <title>Fetchmail-&fetchmail-version;</title>
|
---|
[481b3e8] | 20 |
|
---|
[3bac165] | 21 | <indexterm zone="fetchmail">
|
---|
| 22 | <primary sortas="a-Fetchmail">Fetchmail</primary>
|
---|
| 23 | </indexterm>
|
---|
[481b3e8] | 24 |
|
---|
[3bac165] | 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Fetchmail</title>
|
---|
[481b3e8] | 27 |
|
---|
[7c56ece] | 28 | <para>
|
---|
| 29 | The <application>Fetchmail</application> package contains a mail
|
---|
| 30 | retrieval program. It retrieves mail from remote mail servers and
|
---|
| 31 | forwards it to the local (client) machine's delivery system, so it can
|
---|
| 32 | then be read by normal mail user agents.
|
---|
| 33 | </para>
|
---|
[481b3e8] | 34 |
|
---|
[a860f5da] | 35 | &lfs120_checked;
|
---|
[06f76d2c] | 36 |
|
---|
[3bac165] | 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing='compact'>
|
---|
| 39 | <listitem>
|
---|
[7c56ece] | 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&fetchmail-download-http;"/>
|
---|
| 42 | </para>
|
---|
[3bac165] | 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
[7c56ece] | 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&fetchmail-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
[3bac165] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[7c56ece] | 50 | <para>
|
---|
| 51 | Download MD5 sum: &fetchmail-md5sum;
|
---|
| 52 | </para>
|
---|
[3bac165] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[7c56ece] | 55 | <para>
|
---|
| 56 | Download size: &fetchmail-size;
|
---|
| 57 | </para>
|
---|
[3bac165] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[7c56ece] | 60 | <para>
|
---|
| 61 | Estimated disk space required: &fetchmail-buildsize;
|
---|
| 62 | </para>
|
---|
[3bac165] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[7c56ece] | 65 | <para>
|
---|
| 66 | Estimated build time: &fetchmail-time;
|
---|
| 67 | </para>
|
---|
[3bac165] | 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
[481b3e8] | 70 |
|
---|
[3bac165] | 71 | <bridgehead renderas="sect3">Fetchmail Dependencies</bridgehead>
|
---|
[481b3e8] | 72 |
|
---|
[d92abe56] | 73 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 74 | <para role="recommended">
|
---|
[c48bc3ba] | 75 | a local MDA (<xref linkend="procmail"/>)
|
---|
| 76 | </para>
|
---|
[481b3e8] | 77 |
|
---|
[3bac165] | 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c48bc3ba] | 79 | <para role="optional">
|
---|
[afe4b852] | 80 | <!-- hesiod was at ftp://athena-dist.mit.edu/pub/ATHENA/hesiod/ but that
|
---|
| 81 | is dead. Debian had 3.2.1, git hub has a very old 3.1.
|
---|
| 82 | libintl is part of gettext so enabled by default on LFS -->
|
---|
[4f9e6ae5] | 83 | <xref linkend="mitkrb"/> and
|
---|
| 84 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>
|
---|
[c48bc3ba] | 85 | </para>
|
---|
[481b3e8] | 86 |
|
---|
[c9194c7] | 87 | <bridgehead renderas="sect4">Optional (for running fetchmailconf)</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
| 89 | <xref linkend="python3"/>, built after
|
---|
| 90 | <xref linkend="tk"/>, with the
|
---|
[75e3e09] | 91 | <ulink url="https://python-future.org/">py-future</ulink> package
|
---|
[c9194c7] | 92 | </para>
|
---|
| 93 |
|
---|
[3bac165] | 94 | </sect2>
|
---|
[481b3e8] | 95 |
|
---|
[3bac165] | 96 | <sect2 role="installation">
|
---|
| 97 | <title>Installation of Fetchmail</title>
|
---|
[481b3e8] | 98 |
|
---|
[afe4b852] | 99 | <para>
|
---|
| 100 | Create a dedicated user for the fetchmail program.
|
---|
| 101 | Issue the following commands as the
|
---|
| 102 | <systemitem class="username">root</systemitem> user:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <screen role="root"><userinput>useradd -c "Fetchmail User" -d /dev/null -g nogroup \
|
---|
| 106 | -s /bin/false -u 38 fetchmail</userinput></screen>
|
---|
| 107 |
|
---|
[7c56ece] | 108 | <para>
|
---|
| 109 | Install <application>Fetchmail</application> by running the following
|
---|
| 110 | commands:
|
---|
| 111 | </para>
|
---|
[481b3e8] | 112 |
|
---|
[afe4b852] | 113 | <screen><userinput>PYTHON=python3 \
|
---|
| 114 | ./configure --prefix=/usr \
|
---|
[4f9e6ae5] | 115 | --enable-fallback=procmail &&
|
---|
[46441976] | 116 | make</userinput></screen>
|
---|
| 117 |
|
---|
[afe4b852] | 118 | <para>
|
---|
| 119 | To test the results, issue: <command>make check</command>.
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
[46441976] | 122 |
|
---|
[7c56ece] | 123 | <para>
|
---|
| 124 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 125 | </para>
|
---|
[46441976] | 126 |
|
---|
[afe4b852] | 127 | <screen role='root'><userinput>make install &&
|
---|
| 128 | chown -v fetchmail:nogroup /usr/bin/fetchmail</userinput></screen>
|
---|
[481b3e8] | 129 |
|
---|
[3bac165] | 130 | </sect2>
|
---|
[481b3e8] | 131 |
|
---|
[3bac165] | 132 | <sect2 role="commands">
|
---|
[e3353b3] | 133 | <title>Command Explanations</title>
|
---|
[481b3e8] | 134 |
|
---|
[afe4b852] | 135 | <para>
|
---|
| 136 | <parameter>PYTHON=python3</parameter>: a version of Python is
|
---|
| 137 | <emphasis>required</emphasis>, but only used to install a module to allow
|
---|
| 138 | fetchmailconf to be run. That module is unmaintained and should not be
|
---|
| 139 | used.
|
---|
| 140 | </para>
|
---|
[481b3e8] | 141 |
|
---|
[7c56ece] | 142 | <para>
|
---|
| 143 | <parameter>--enable-fallback=procmail</parameter>: This tells
|
---|
| 144 | <application>Fetchmail</application> to hand incoming mail to
|
---|
| 145 | <application>Procmail</application> for delivery, if the port 25 mail
|
---|
| 146 | server is not present or not responding.
|
---|
| 147 | </para>
|
---|
[481b3e8] | 148 |
|
---|
[3bac165] | 149 | </sect2>
|
---|
[481b3e8] | 150 |
|
---|
[3bac165] | 151 | <sect2 role="configuration">
|
---|
| 152 | <title>Configuring Fetchmail</title>
|
---|
[481b3e8] | 153 |
|
---|
[3bac165] | 154 | <sect3 id="fetchmail-config">
|
---|
[e3353b3] | 155 | <title>Config Files</title>
|
---|
[481b3e8] | 156 |
|
---|
[7c56ece] | 157 | <para>
|
---|
| 158 | <filename>~/.fetchmailrc</filename>
|
---|
| 159 | </para>
|
---|
[481b3e8] | 160 |
|
---|
[3bac165] | 161 | <indexterm zone="fetchmail fetchmail-config">
|
---|
| 162 | <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
|
---|
| 163 | </indexterm>
|
---|
[481b3e8] | 164 |
|
---|
[3bac165] | 165 | </sect3>
|
---|
[481b3e8] | 166 |
|
---|
[3bac165] | 167 | <sect3>
|
---|
| 168 | <title>Configuration Information</title>
|
---|
[481b3e8] | 169 |
|
---|
[fecfae0] | 170 | <note>
|
---|
| 171 | <para>
|
---|
| 172 | If you are connecting to a mailserver that supports SSL/TLS-wrapped
|
---|
| 173 | or "implicit" mode on a dedicated port (default 993) you should use
|
---|
| 174 | <command>fetchmail --ssl</command> or add the option 'ssl' in an
|
---|
| 175 | rcfile.
|
---|
| 176 | </para>
|
---|
| 177 | </note>
|
---|
| 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>
|
---|