[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[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 " ">
|
---|
[ffc112c6] | 9 | <!ENTITY fetchmail-md5sum "33a916a14b91ba932b970fe02d28f058">
|
---|
| 10 | <!ENTITY fetchmail-size "1.2 MB">
|
---|
| 11 | <!ENTITY fetchmail-buildsize "12 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 |
|
---|
[fc09938] | 35 | &lfs122_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">
|
---|
[4f9e6ae5] | 80 | <xref linkend="mitkrb"/> and
|
---|
| 81 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>
|
---|
[c48bc3ba] | 82 | </para>
|
---|
[481b3e8] | 83 |
|
---|
[c9194c7] | 84 | <bridgehead renderas="sect4">Optional (for running fetchmailconf)</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
| 86 | <xref linkend="python3"/>, built after
|
---|
| 87 | <xref linkend="tk"/>, with the
|
---|
[75e3e09] | 88 | <ulink url="https://python-future.org/">py-future</ulink> package
|
---|
[c9194c7] | 89 | </para>
|
---|
| 90 |
|
---|
[3bac165] | 91 | </sect2>
|
---|
[481b3e8] | 92 |
|
---|
[3bac165] | 93 | <sect2 role="installation">
|
---|
| 94 | <title>Installation of Fetchmail</title>
|
---|
[481b3e8] | 95 |
|
---|
[afe4b852] | 96 | <para>
|
---|
| 97 | Create a dedicated user for the fetchmail program.
|
---|
| 98 | Issue the following commands as the
|
---|
| 99 | <systemitem class="username">root</systemitem> user:
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
| 102 | <screen role="root"><userinput>useradd -c "Fetchmail User" -d /dev/null -g nogroup \
|
---|
| 103 | -s /bin/false -u 38 fetchmail</userinput></screen>
|
---|
| 104 |
|
---|
[7c56ece] | 105 | <para>
|
---|
| 106 | Install <application>Fetchmail</application> by running the following
|
---|
| 107 | commands:
|
---|
| 108 | </para>
|
---|
[481b3e8] | 109 |
|
---|
[afe4b852] | 110 | <screen><userinput>PYTHON=python3 \
|
---|
| 111 | ./configure --prefix=/usr \
|
---|
[4f9e6ae5] | 112 | --enable-fallback=procmail &&
|
---|
[46441976] | 113 | make</userinput></screen>
|
---|
| 114 |
|
---|
[afe4b852] | 115 | <para>
|
---|
| 116 | To test the results, issue: <command>make check</command>.
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
[46441976] | 119 |
|
---|
[7c56ece] | 120 | <para>
|
---|
| 121 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 122 | </para>
|
---|
[46441976] | 123 |
|
---|
[afe4b852] | 124 | <screen role='root'><userinput>make install &&
|
---|
| 125 | chown -v fetchmail:nogroup /usr/bin/fetchmail</userinput></screen>
|
---|
[481b3e8] | 126 |
|
---|
[3bac165] | 127 | </sect2>
|
---|
[481b3e8] | 128 |
|
---|
[3bac165] | 129 | <sect2 role="commands">
|
---|
[e3353b3] | 130 | <title>Command Explanations</title>
|
---|
[481b3e8] | 131 |
|
---|
[afe4b852] | 132 | <para>
|
---|
| 133 | <parameter>PYTHON=python3</parameter>: a version of Python is
|
---|
| 134 | <emphasis>required</emphasis>, but only used to install a module to allow
|
---|
| 135 | fetchmailconf to be run. That module is unmaintained and should not be
|
---|
| 136 | used.
|
---|
| 137 | </para>
|
---|
[481b3e8] | 138 |
|
---|
[7c56ece] | 139 | <para>
|
---|
| 140 | <parameter>--enable-fallback=procmail</parameter>: This tells
|
---|
| 141 | <application>Fetchmail</application> to hand incoming mail to
|
---|
| 142 | <application>Procmail</application> for delivery, if the port 25 mail
|
---|
| 143 | server is not present or not responding.
|
---|
| 144 | </para>
|
---|
[481b3e8] | 145 |
|
---|
[3bac165] | 146 | </sect2>
|
---|
[481b3e8] | 147 |
|
---|
[3bac165] | 148 | <sect2 role="configuration">
|
---|
| 149 | <title>Configuring Fetchmail</title>
|
---|
[481b3e8] | 150 |
|
---|
[3bac165] | 151 | <sect3 id="fetchmail-config">
|
---|
[e3353b3] | 152 | <title>Config Files</title>
|
---|
[481b3e8] | 153 |
|
---|
[7c56ece] | 154 | <para>
|
---|
| 155 | <filename>~/.fetchmailrc</filename>
|
---|
| 156 | </para>
|
---|
[481b3e8] | 157 |
|
---|
[3bac165] | 158 | <indexterm zone="fetchmail fetchmail-config">
|
---|
| 159 | <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
|
---|
| 160 | </indexterm>
|
---|
[481b3e8] | 161 |
|
---|
[3bac165] | 162 | </sect3>
|
---|
[481b3e8] | 163 |
|
---|
[3bac165] | 164 | <sect3>
|
---|
| 165 | <title>Configuration Information</title>
|
---|
[481b3e8] | 166 |
|
---|
[fecfae0] | 167 | <note>
|
---|
| 168 | <para>
|
---|
| 169 | If you are connecting to a mailserver that supports SSL/TLS-wrapped
|
---|
| 170 | or "implicit" mode on a dedicated port (default 993) you should use
|
---|
| 171 | <command>fetchmail --ssl</command> or add the option 'ssl' in an
|
---|
| 172 | rcfile.
|
---|
| 173 | </para>
|
---|
| 174 | </note>
|
---|
| 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>
|
---|