source: server/mail/courier.xml@ 13242dc6

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 6.0 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gimp3 gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 13242dc6 was c6301dc, checked in by Randy McMurchy <randy@…>, 20 years ago

Courier corrections

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3300 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 36.9 KB
RevLine 
[0931098]1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7<!ENTITY courier-download-http "http://prdownloads.sourceforge.net/courier/courier-&courier-version;.tar.bz2">
8<!ENTITY courier-download-ftp " ">
[ebe1291]9<!ENTITY courier-size "4.3 MB">
10<!ENTITY courier-buildsize "102 MB">
11<!ENTITY courier-time "2.62 SBU">
[0931098]12
13]>
14
[ebe1291]15<sect1 id="courier-package" xreflabel="Courier-&courier-version;">
[a0f03b0]16<sect1info>
[5cd0959d]17<othername>$LastChangedBy$</othername>
18<date>$Date$</date>
[a0f03b0]19</sect1info>
[00bb024c]20<?dbhtml filename="courier.html"?>
[1a1da48]21<title>Courier-&courier-version;</title>
[ebe1291]22<indexterm zone="courier-package">
23<primary sortas="a-courier-package">Courier MTA</primary></indexterm>
[f45b1953]24
[0931098]25<sect2>
26<title>Introduction to <application>Courier</application></title>
27
28<para>The <application>Courier</application> package contains a Mail Transport
29Agent (<acronym>MTA</acronym>). This is useful for sending email to other users
30of your host machine. It can also be configured to be a central mail server for
31your domain or a mail relay agent. The <application>Courier</application>
32packages also includes a web-based email interface, <acronym>IMAP</acronym>,
33<acronym>IMAP</acronym>-<acronym>SSL</acronym>, <acronym>POP</acronym>3, and
34<acronym>POP</acronym>3-<acronym>SSL</acronym>.</para>
35
36<sect3><title>Package information</title>
37<itemizedlist spacing='compact'>
[7ee9849]38<listitem><para>Download (HTTP):
39<ulink url="&courier-download-http;"/></para></listitem>
40<listitem><para>Download (FTP):
41<ulink url="&courier-download-ftp;"/></para></listitem>
[0931098]42<listitem><para>Download size: &courier-size;</para></listitem>
[7ee9849]43<listitem><para>Estimated disk space required:
44&courier-buildsize;</para></listitem>
45<listitem><para>Estimated build time:
46&courier-time;</para></listitem></itemizedlist>
[0931098]47</sect3>
48
49<sect3><title><application>Courier</application> dependencies</title>
50<sect4><title>Required</title>
[ebe1291]51<para><xref linkend="gdbm"/></para>
[7ee9849]52</sect4>
[0931098]53<sect4><title>Optional</title>
[7ee9849]54<para><xref linkend="mysql"/> or <xref linkend="postgresql"/>,
[0931098]55<xref linkend="Linux_PAM"/>,
[939cf0da]56<xref linkend="openssl-package"/>,
[0931098]57<xref linkend="fam"/>,
58<xref linkend="openldap"/>,
59<xref linkend="apache"/>,
60<xref linkend="ispell"/> or <xref linkend="aspell"/>,
61<xref linkend="gnupg"/>,
[216ef4f]62<xref linkend="expect"/>,
[ebe1291]63<xref linkend="gs"/> or <xref linkend="espgs"/>,
[0931098]64<ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink> and
65<ulink url="http://alpha.greenie.net/mgetty/">Mgetty+Sendfax</ulink>
66</para></sect4>
67</sect3>
68
69</sect2>
70
71<sect2>
72<title>Installation of <application>Courier</application></title>
[ebe1291]73<note><para><application>Courier's</application> tarball must be extacted as an
[c6301dc]74unprivileged user or the configure script will fail.</para></note>
[ebe1291]75
[17143f33]76<para>Before you compile the program, you need to create the courier user
[ebe1291]77and group that is expected to be in place when the install script executes.
[17143f33]78As the root user, add the courier user and group with the following
79commands:</para>
[0931098]80
[17143f33]81<screen><userinput role="root"><command>groupadd courier &amp;&amp;
[7ee9849]82useradd -c 'Courier Mail Server' -d /dev/null \
83 -g courier -s /bin/false courier</command></userinput></screen>
[0931098]84
[ebe1291]85<para>The install script also expects a bin user. If you already have a user
[0931098]86named bin, this step can be safely ignored.</para>
87
[17143f33]88<screen><userinput role="root"><command>useradd -c 'bin' -d /dev/null -g bin -u 1 bin</command></userinput></screen>
[0931098]89
[ebe1291]90<para><application>Courierfilter</application> requires the directory
91<filename class="directory">/var/run/courier</filename> to store
92all the <application>Courier</application> pid and lockfiles.
93<filename class="directory">/var/lock/subsys</filename> also must exist
94for the master lock file for <application>Courier</application>. Issue
95the following commands to create these directories:</para>
[0931098]96
[17143f33]97<screen><userinput role="root"><command>install -d /var/run/courier -o courier -g courier -m755 &amp;&amp;
[ebe1291]98install -d /var/lock/subsys -o root -g root -m755</command></userinput></screen>
[0931098]99
[c6301dc]100<para>Build <application>Courier</application> as an unprivileged user
[ebe1291]101with the following commands:</para>
[0931098]102
103<screen><userinput><command>./configure --prefix=/usr --libexecdir=/usr/lib/courier \
104 --datadir=/usr/share/courier --sysconfdir=/etc/courier \
105 --localstatedir=/var/lib/courier --with-piddir=/var/run/courier \
[7ee9849]106 --disable-root-check --with-mailuser=courier \
107 --with-mailgroup=courier \
[0931098]108 --with-paranoid-smtpext --disable-autorenamesent \
109 --enable-workarounds-for-imap-client-bugs --with-db=gdbm &amp;&amp;
[ebe1291]110make</command></userinput></screen>
111
[17143f33]112<para>Once again, become the root user and install
113<application>Courier</application> with the following commands:</para>
[ebe1291]114
[17143f33]115<screen><userinput role="root"><command>make install &amp;&amp;
[0931098]116make install-configure</command></userinput></screen>
117
118</sect2>
119
120<sect2>
121<title>Command explanations</title>
122
123<para><parameter>--libexecdir=/usr/lib/courier</parameter>: Specifies
124the directory which contains programs and libraries that cannot be
125directly executed from the command-line.</para>
126
127<para><parameter>--datadir=/usr/share/courier</parameter>: Specifies the
128directory where miscellaneous shell scripts,
129<application>Perl</application> scripts, and data files will be
130installed.</para>
131
132<para><parameter>--localstatedir=/var/spool/courier</parameter>:
133Specifies the directory that will hold the mail queue, and other
134temporary data.</para>
135
136<para><parameter>--with-piddir=/var/run/courier</parameter>: Specifies
137the directory where <application>Courier</application>'s
138<filename>PID</filename> files are stored when
139<application>Courier</application> is active.</para>
140
141<para><option>--disable-root-check</option>: Allows
142<application>Courier</application> to be built as the root user.</para>
143
144<para><parameter>--with-mailuser=courier</parameter>: All except two
145<application>Courier</application> daemons run as a non-privileged user.
146This option specifies the userid that <application>Courier</application>
147will install and run as.</para>
148
149<para><parameter>--with-mailgroup=courier</parameter>: like
150<option>--with-mailuser</option>, but specifies the group
151<acronym>ID</acronym>.</para>
152
153<para><option>--with-paranoid-smtpext</option>: Be paranoid when
154negotiating Courier-specific <acronym>ESMTP</acronym> extensions with
155remote servers. The <application>Courier</application> mail server
156defines and implements certain experimental <acronym>ESMTP</acronym>
157extensions: XVERP and XEXDATA. Problems may result in the event that
158someone else uses the same name to implement some other extension. If
159this option is specified, <application>Courier's</application>
160<acronym>ESMTP</acronym> server will also advertise a dummy
161<acronym>ESMTP</acronym> capability called XCOURIEREXTENSIONS, and will
162not recognize any Courier-specific extensions unless the remote mail
163server also advertises this dummy <acronym>ESMTP</acronym>
164capability.</para>
165
166<para><option>--disable-autorenamesent</option>: Do not rename the Sent
167folder every month. This option can also be controlled by the
168<envar>SQWEBMAIL_AUTORENAMESENT</envar> environment variable.</para>
169
170<para><option>--enable-workarounds-for-imap-client-bugs</option>: There
171are several confirmed bugs in some <acronym>IMAP</acronym> clients that
172do not properly implement the <acronym>IMAP</acronym>4rev1 protocol.
173This option enables some workarounds for those buggy
174<acronym>IMAP</acronym> clients. NOTE: <command>make check</command>
175will fail if this option is used. You should first configure without
176this option, and if all post-configuration tests succeed, rerun
177configure with this option and recompile.</para>
178
179<para><parameter>--with-db=gdbm</parameter>:
180<application>Courier</application> requires either the
181<application><acronym>GDBM</acronym></application> or the
182<application>DB</application> database library.
183<application><acronym>GDBM</acronym></application> is used if both are
[ebe1291]184present. This option forces the selection of
185<application>GDBM</application> as courier is currently broken when used
186with <application>DB</application>.</para>
[0931098]187
188<!-- # Note - Courier will build fine with <xref linkend="db"/>, but all
189the database files will not be created correctly -->
190
191<para><parameter>--with-ispell=/usr/bin/aspell</parameter>:
192<application>Courier</application>'s webmail server can use spell
193checking, if <command>configure</command> finds
194<application>ispell</application> or if you explicitly set the location
195of <application>aspell</application>.</para>
196
[7ee9849]197<para><parameter>--enable-mimetypes=<replaceable>[location of mime.types
198file]</replaceable></parameter>: Use this switch if you receive an error
199saying that the <filename>mime.types</filename> file could not be found.</para>
[0931098]200
201</sect2>
202
[17143f33]203<sect2 id="etc-courier-star">
[0931098]204<title>Configuring <application>Courier</application></title>
[17143f33]205<indexterm zone="courier-package etc-courier-star">
206<primary sortas="e-etc-courier-star">/etc/courier/*</primary></indexterm>
[0931098]207
[17143f33]208<sect3><title>Configuration Files</title>
209<para><filename>/etc/courier/*</filename></para>
210</sect3>
[0931098]211
[17143f33]212<sect3><title>Configuration Information</title>
[0931098]213
[17143f33]214<para>While still as root, you will need to create the following files with
215the contents specified.</para>
[0931098]216
217<para><filename>/etc/courier/defaultdomain</filename></para>
218
[17143f33]219<screen><userinput role="root"><command>cat &gt; /etc/courier/defaultdomain &lt;&lt; "EOF"</command>
[0931098]220<replaceable>[yourdomain]</replaceable>
221<command>EOF</command></userinput></screen>
222
223<para><filename>/etc/courier/me</filename></para>
224
[17143f33]225<screen><userinput role="root"><command>cat &gt; /etc/courier/me &lt;&lt; "EOF"</command>
[0931098]226<replaceable>[servername.yourdomain]</replaceable>
227<command>EOF</command></userinput></screen>
228
229<para><filename>/etc/courier/locals</filename></para>
230
[17143f33]231<screen><userinput role="root"><command>cat &gt; /etc/courier/locals &lt;&lt; "EOF"</command>
[0931098]232localhost
233<replaceable>[yourdomain]</replaceable>
234<command>EOF</command></userinput></screen>
235
236<para><filename>/etc/courier/esmtpacceptmailfor.dir/system</filename></para>
237
[17143f33]238<screen><userinput role="root"><command>cat &gt; /etc/courier/esmtpacceptmailfor.dir/system &lt;&lt; "EOF"</command>
[0931098]239localhost
240<replaceable>[yourdomain]</replaceable>
241<command>EOF</command></userinput></screen>
242
[17143f33]243<para>You will also need to edit the
244<filename>/etc/courier/aliases/system</filename> file and change the
[0931098]245following entry.</para>
246
247<screen><userinput>postmaster: <replaceable>[your administrator email]</replaceable></userinput></screen>
248
249<para>If you want to deny access from some hosts from sending mail, you
250will need to edit the
251<filename>/etc/courier/smtpaccess/default</filename> file.</para>
252
[ebe1291]253<para>If you wish to host mail for non local domains including virtual
[17143f33]254domains, you must add them to
255<filename>/etc/courier/hosteddomains</filename>. This file should exist
[c6301dc]256whether you need a hosted domain list or not:</para>
[ebe1291]257
[17143f33]258<screen><userinput role="root"><command>touch /etc/courier/hosteddomains</command></userinput></screen>
[ebe1291]259
[0931098]260<para>After the above steps are completed you will need to run the
261following commands:</para>
262
[17143f33]263<screen><userinput role="root"><command>makesmtpaccess &amp;&amp;
[0931098]264makehosteddomains &amp;&amp;
265makealiases</command></userinput></screen>
266
[ebe1291]267<para>For each user, you will need to create a
268<filename class="directory">Maildir</filename> directory:</para>
[0931098]269
[17143f33]270<screen><userinput role="root"><command>cd /home/<replaceable>[username]</replaceable> &amp;&amp;
[ebe1291]271maildirmake Maildir &amp;&amp;
272chown <replaceable>[username]</replaceable>.<replaceable>[username]</replaceable> Maildir -R</command></userinput></screen>
[0931098]273
[ebe1291]274<para>If you wish to use <acronym>SSL</acronym> with
275<application>Courier</application>, you should obtain certificates and
276store them in <filename>/usr/share/courier</filename>. You can
277optionally create self-signed, test certificates with the following
278commands:</para>
[0931098]279
[17143f33]280<screen><userinput role="root"><command>mkesmtpdcert &amp;&amp;
[ebe1291]281mkimapdcert &amp;&amp;
282mkpop3dcert</command></userinput></screen>
[0931098]283
[c6301dc]284<para>All of <application>Courier</application>'s configuration files reside
285in the directory <filename class="directory">/etc/courier/</filename>. For
286each service <acronym>SMTP</acronym>, <acronym>POP3</acronym> and
[ebe1291]287<acronym>IMAP</acronym>, you will have a standard config file, and an
288<acronym>SSL</acronym> config file. For each service that you
289wish to utilize, you will need to edit the configuration file, and
290change the <replaceable>[DAEMON]</replaceable>START variable from 'NO' to
291'YES'. For example, to use <acronym>SMTP</acronym> with
292<acronym>SSL</acronym>, you'll need to edit
293<filename>/etc/courier/esmtpd-ssl</filename> and change the value of
294'ESMTPDSSLSTART' to 'YES'. Make the same change for each service
295configuration that you wish to use with
[17143f33]296<application>Courier</application>.</para>
[0931098]297
[ebe1291]298<para>If you wish to use <acronym>LDAP</acronym>, an
299<acronym>LDAP</acronym> configuration file should be created:</para>
[0931098]300
[17143f33]301<screen><userinput role="root"><command>echo "LDAPALIASDSTART=YES" > /etc/courier/ldapaliasd</command></userinput></screen>
[0931098]302
[ebe1291]303<para>Similarly, if you wish to use webmail, you should create the webmail
304configuration file:</para>
[0931098]305
[17143f33]306<screen><userinput role="root"><command>echo "WEBMAILDSTART=YES" > /etc/courier/webmaild</command></userinput></screen>
[0931098]307
[ebe1291]308<para>You will also need to copy the <filename>webmail</filename> file from
[c6301dc]309<filename>/usr/lib/courier/courier/webmail</filename> to the
310<filename class='directory'>cgi-bin</filename> directory of your
311<application>Apache</application> server.</para>
[0931098]312
[17143f33]313<screen><userinput role="root"><command>cp -a /usr/lib/courier/courier/webmail/webmail /srv/www/cgi-bin</command></userinput></screen>
[0931098]314
[ebe1291]315<para>You will then need to copy the images to a directory under your
[c6301dc]316<filename class='directory'>htdocs</filename> directory of your
[ebe1291]317<application>Apache</application> server. The directory needs to be named
[c6301dc]318<filename class='directory'>webmail</filename> or you need to specify it
319during the configure phase with
320<parameter>--enable-imageurl=<replaceable>[URL]</replaceable></parameter>.</para>
[0931098]321
[17143f33]322<screen><userinput role="root"><command>cp -a /usr/share/courier/sqwebmail/images /srv/www/htdocs/webmail</command></userinput></screen>
[0931098]323
[ebe1291]324<para>If you wish to utilze the webadmin utility, you will need to copy the
325<filename>webadmin</filename> file from
326<filename class="directory">/usr/lib/courier/courier/webmail</filename>
327to your <filename class="directory">cgi-bin</filename> directory of your
328<application>Apache</application> server.</para>
[0931098]329
[17143f33]330<screen><userinput role="root"><command>cp -a /usr/lib/courier/courier/webmail/webadmin /srv/www/cgi-bin</command></userinput></screen>
[0931098]331
[17143f33]332<para>You also need to put the password into the file
333<filename>/etc/courier/webadmin/password</filename>:</para>
[0931098]334
[17143f33]335<screen><userinput role="root"><command>cat &gt; /etc/courier/webadmin/password &lt;&lt; "EOF"</command>
[ebe1291]336<replaceable>[password]</replaceable>
337<command>EOF</command></userinput></screen>
[0931098]338
[ebe1291]339<para>If you are not using <acronym>SSL</acronym> on your <application>Apache
340</application> server, you will also need to add
341<filename>/etc/courier/webadmin/unsecureok</filename>, so you will be able
342to use your web based administration tool.</para>
[0931098]343
[17143f33]344<screen><userinput role="root"><command>touch /etc/courier/webadmin/unsecureok</command></userinput></screen>
[0931098]345
[c6301dc]346<para>If you use <application>Linux-PAM</application> on your system,
[ebe1291]347you will need to create the <acronym>PAM</acronym> configuration files:</para>
[0931098]348
[17143f33]349<screen><userinput role="root"><command>cat &gt; /etc/pam.d/esmtp &lt;&lt; "EOF"</command>
[ebe1291]350# Begin /etc/pam.d/esmtp
[0931098]351
[ebe1291]352auth required pam_unix.so try_first_pass
353account required pam_unix.so
354session required pam_unix.so
[0931098]355
[ebe1291]356# End /etc/pam.d/esmtp
357<command>EOF
358cat &gt; /etc/pam.d/pop3 &lt;&lt; "EOF"</command>
359# Begin /etc/pam.d/pop3
[0931098]360
[ebe1291]361auth required pam_unix.so try_first_pass
362account required pam_unix.so
363session required pam_unix.so
364
365# End /etc/pam.d/pop3
366<command>EOF
367cat &gt; /etc/pam.d/imap &lt;&lt; "EOF"</command>
368# Begin /etc/pam.d/imap
369
370auth required pam_unix.so try_first_pass
371account required pam_unix.so
372session required pam_unix.so
373
374# End /etc/pam.d/imap
375<command>EOF
376cat &gt; /etc/pam.d/webmail &lt;&lt; "EOF"</command>
377# Begin /etc/pam.d/webmail
378
379auth required pam_unix.so try_first_pass
380account required pam_unix.so
381session required pam_unix.so
382
383# End /etc/pam.d/webmail
384<command>EOF</command></userinput></screen>
385
[c6301dc]386<para id="courier-init">Finally, if you wish to start the
387<application>Courier</application> server at boot, install
[ebe1291]388the <filename>/etc/rc.d/init.d/courier</filename> bootscript included in the
389<xref linkend="intro-important-bootscripts"/> package.</para>
390<indexterm zone="courier-package courier-init">
391<primary sortas="f-courier-init">courier</primary></indexterm>
392
[17143f33]393<screen><userinput role="root"><command>make install-courier</command></userinput></screen>
[ebe1291]394
395</sect3>
396
397<!-- Begin virtual user setup * To be removed once added to the hint. -->
398
399<sect3>
400
401<title>Configuring for virtual users</title>
402
[17143f33]403<para>These instructions will configure <application>Courier</application>
[ebe1291]404to lookup virtual users in a <application>MySQL</application> database.
405Begin by making the following changes to
406<filename>/etc/courier/authmysqlrc</filename>:</para>
407
408<screen><userinput>MYSQL_SERVER localhost
409MYSQL_USERNAME courier
410MYSQL_PASSWORD <replaceable>[your choice]</replaceable>
411MYSQL_SOCKET /tmp/mysql.sock
412MYSQL_PORT 3306
413MYSQL_DATABASE courier_mail
414MYSQL_USER_TABLE users
415MYSQL_CLEAR_PWFIELD clear
416DEFAULT DOMAIN <replaceable>[your domain]</replaceable>
417MYSQL_QUOTA_FIELD quota</userinput></screen>
418
419<para>Connect to <application>MySQL</application>:</para>
420
[17143f33]421<screen><userinput role="root"><command>mysql -p</command></userinput></screen>
[ebe1291]422
423<para>Create the <filename>courier_mail</filename> database and setup
424the users table:</para>
425
[17143f33]426<screen><userinput role="root"><command>CREATE DATABASE courier_mail;
[ebe1291]427USE courier_mail
428CREATE TABLE users (
429id char(128) DEFAULT '' NOT NULL,
430crypt char(128) DEFAULT '' NOT NULL,
431clear char(128) DEFAULT '' NOT NULL,
432name char(128) DEFAULT '' NOT NULL,
433uid int(10) unsigned DEFAULT '65534' NOT NULL,
434gid int(10) unsigned DEFAULT '65534' NOT NULL,
435home char(255) DEFAULT '' NOT NULL,
436quota char(255) DEFAULT '' NOT NULL,
437KEY id (id(128))
438);</command></userinput></screen>
[0931098]439
[ebe1291]440<para>Grant all priveledges to the courier user created earlier:</para>
[0931098]441
[17143f33]442<screen><userinput role="root"><command>GRANT ALL PRIVILEGES ON *.* TO courier@localhost \
[ebe1291]443 IDENTIFIED BY '<replaceable>[password]</replaceable>' WITH GRANT OPTION;
444QUIT</command></userinput></screen>
[0931098]445
[ebe1291]446<para>Create a virtual mailman user and group:</para>
[17143f33]447<screen><userinput role="root"><command>groupadd -g 9000 vmailman &amp;&amp;
[0931098]448useradd -c 'Virtual Mailman' -g vmailman -m -k /dev/null -u 9000 vmailman</command></userinput></screen>
449
[ebe1291]450<para>Create a mail directory for a new virtual user:</para>
[0931098]451
[17143f33]452<screen><userinput role="root"><command>cd /home/vmailman &amp;&amp;
[0931098]453mkdir <replaceable>[virtual_user]</replaceable> &amp;&amp;
454cd <replaceable>[virtual_user]</replaceable> &amp;&amp;
455maildirmake Maildir &amp;&amp;
456chown vmailman.vmailman Maildir -R</command></userinput></screen>
457
[ebe1291]458<para>Now, connect the the <application>MySQL</application> database as
459the courier user:</para>
[0931098]460
[17143f33]461<screen><userinput role="root"><command>mysql -u courier -p</command></userinput></screen>
[ebe1291]462
463<para>To add the virtual user you need to enter at least one version of the
464password either clear text or encrypted.</para>
465
466<para>Add the first virtual user with the following commands:</para>
[0931098]467
[17143f33]468<screen><userinput role="root"><command>USE courier_mail
[0931098]469INSERT INTO users VALUES (
470'<replaceable>[virtual_users]</replaceable>@<replaceable>[domain.com]</replaceable>,
471'<replaceable>[encrypted password or blank]</replaceable>',
472'<replaceable>[clear text password or blank]</replaceable>',
473'<replaceable>[User's Name]</replaceable>',
4749000,
4759000,
476'<replaceable>[location of Maildir]</replaceable>',
477'<replaceable>[Quota in Bytes']</replaceable>
478);
479QUIT</command></userinput></screen>
480
481<para>For example:</para>
482
[17143f33]483<screen><userinput role="root"><command>INSERT INTO users VALUES (
[0931098]484'blfsuser@linuxfromscratch.org',
485'',
486'password',
487'BLFS User',
4889000,
4899000,
490'/home/vmailman/blfsuser',
491''
492);</command></userinput></screen>
493
494</sect3>
495
[ebe1291]496<!-- End of Virtual user setup -->
[0931098]497
498</sect2>
499
500<sect2>
501<title>Contents</title>
502
[ebe1291]503<segmentedlist>
504<segtitle>Installed Programs</segtitle>
505<segtitle>Installed Directories</segtitle>
506<seglistitem>
[17143f33]507<seg>addcr, authenumerate, cancelmsg, courier, courier-config,
508courieresmtpd, courierfilter, courierlogger, couriermlm, couriertcpd,
509couriertls, deliverquota, dotforward, esmtpd, esmtpd-msa, esmtpd-ssl,
510filterctl, imapd, imapd-ssl, lockmail, mailbot, maildiracl, maildirkw,
511maildirmake, maildrop, mailq, makeacceptmailfor, makealiases, makedat,
512makehosteddomains, makemime, makepercentrelay, makesmtpaccess,
513makesmtpaccess-msa, makeuserdb, makeuucpneighbors, mimegpg,
514mkesmtpdcert, mkimapdcert, mkpop3dcert, pop3d, pop3d-ssl, preline,
515pw2userdb, reformail, reformime, rmail, sendmail, sharedindexinstall,
516sharedindexsplit, showconfig, showmodules, testmxlookup, userdb,
517userdbpw, vchkpw2userdb, webgpg, webmaild</seg>
[ebe1291]518
[c6301dc]519<seg>/etc/courier, /usr/lib/courier, /usr/share/courier, /var/lib/courier,
520/var/lock/subsys, /var/run/courier and /var/spool/courier</seg>
[ebe1291]521
522</seglistitem>
523</segmentedlist>
524
525<variablelist>
526<bridgehead renderas="sect3">Short Descriptions</bridgehead>
527<?dbfo list-presentation="list"?>
528
529<varlistentry id="cancelmsg">
530<term><command>cancelmsg</command></term>
531<listitem><para>removes a message from the mail queue.</para>
532<indexterm zone="courier-package cancelmsg">
533<primary sortas="b-cancelmsg">cancelmsg</primary></indexterm>
534</listitem>
535</varlistentry>
536
537<varlistentry id="courier">
538<term><command>courier</command></term>
[c6301dc]539<listitem><para>administrative command used to control the
540<application>Courier</application> scheduling engine.</para>
[ebe1291]541<indexterm zone="courier-package courier">
542<primary sortas="b-courier">courier</primary></indexterm>
543</listitem>
544</varlistentry>
545
546<varlistentry id="courierfax">
547<term><command>courierfax</command></term>
548<listitem><para>sends email messages by fax.</para>
549<indexterm zone="courier-package courierfax">
550<primary sortas="b-courierfax">courierfax</primary></indexterm>
551</listitem>
552</varlistentry>
553
554<varlistentry id="courierfilter">
555<term><command>courierfilter</command></term>
556<listitem><para>starts and stops all mail filters installed by
557<command>filterctl</command>.</para>
558<indexterm zone="courier-package courierfilter">
559<primary sortas="b-courierfilter">courierfilter</primary></indexterm>
560</listitem>
561</varlistentry>
562
563<varlistentry id="courierldapaliasd">
564<term><command>courierldapaliasd</command></term>
565<listitem><para>supports mail address aliasing using an LDAP directory.</para>
566<indexterm zone="courier-package courierldapaliasd">
567<primary sortas="b-courierldapaliasd">courierldapaliasd</primary></indexterm>
568</listitem>
569</varlistentry>
570
571<varlistentry id="courierlogger">
572<term><command>courierlogger</command></term>
573<listitem><para>captures error messages from other
[17143f33]574<application>Courier</application> applications and forwards them to
[ebe1291]575the system logger.</para>
576<indexterm zone="courier-package courierlogger">
577<primary sortas="b-courierlogger">courierlogger</primary></indexterm>
578</listitem>
579</varlistentry>
580
581<varlistentry id="couriermlm">
582<term><command>couriermlm</command></term>
583<listitem><para>sets up, maintains, and manages mailing lists.</para>
584<indexterm zone="courier-package couriermlm">
585<primary sortas="b-couriermlm">couriermlm</primary></indexterm>
586</listitem>
587</varlistentry>
588
589<varlistentry id="courierperlfilter">
590<term><command>courierperlfilter</command></term>
[c6301dc]591<listitem><para>a sample filter written in
592<application>Perl</application>.</para>
[ebe1291]593<indexterm zone="courier-package courierperlfilter">
594<primary sortas="b-courierperlfilter">courierperlfilter</primary></indexterm>
595</listitem>
596</varlistentry>
597
598<varlistentry id="courierpop3d">
599<term><command>courierpop3d</command></term>
[c6301dc]600<listitem><para>is a <application>Courier</application>
601<acronym>POP</acronym>3 server.</para>
[ebe1291]602<indexterm zone="courier-package courierpop3d">
603<primary sortas="b-courierpop3d">courierpop3d</primary></indexterm>
604</listitem>
605</varlistentry>
606
607<varlistentry id="courierpop3login">
608<term><command>courierpop3login</command></term>
[c6301dc]609<listitem><para>reads the <acronym>POP</acronym>3 userid and password and
610passes them to the authentication modules.</para>
[ebe1291]611<indexterm zone="courier-package courierpop3login">
612<primary sortas="b-courierpop3login">courierpop3login</primary></indexterm>
613</listitem>
614</varlistentry>
615
616<varlistentry id="couriertcpd">
617<term><command>couriertcpd</command></term>
618<listitem><para>accepts incoming network connections, and runs other
[c6301dc]619<application>Courier</application> programs after establishing each network
620connection.</para>
[ebe1291]621<indexterm zone="courier-package couriertcpd">
622<primary sortas="b-couriertcpd">couriertcpd</primary></indexterm>
623</listitem>
624</varlistentry>
625
626<varlistentry id="couriertls">
627<term><command>couriertls</command></term>
[c6301dc]628<listitem><para>is used by applications to encrypt a network connection
629using <acronym>SSL</acronym>/<acronym>TLS</acronym>.</para>
[ebe1291]630<indexterm zone="courier-package couriertls">
631<primary sortas="b-couriertls">couriertls</primary></indexterm>
632</listitem>
633</varlistentry>
634
635<varlistentry id="dotforward">
636<term><command>dotforward</command></term>
[c6301dc]637<listitem><para>is a compatibility module that reads forwarding
638instructions in <filename>$HOME/.forward</filename>.</para>
[ebe1291]639<indexterm zone="courier-package dotforward">
640<primary sortas="b-dotforward">dotforward</primary></indexterm>
641</listitem>
642</varlistentry>
643
644<varlistentry id="dupfilter">
645<term><command>dupfilter</command></term>
[c6301dc]646<listitem><para>is a threaded filter that tries to block junk E-mail by
[ebe1291]647attempting to detect multiple copies of the same message, which are
648rejected.</para>
649<indexterm zone="courier-package dupfilter">
650<primary sortas="b-dupfilter">dupfilter</primary></indexterm>
651</listitem>
652</varlistentry>
653
654<varlistentry id="esmtpd">
655<term><command>esmtpd</command></term>
[c6301dc]656<listitem><para>is a control script for courieresmtpd.</para>
[ebe1291]657<indexterm zone="courier-package esmtpd">
658<primary sortas="b-esmtpd">esmtpd</primary></indexterm>
659</listitem>
660</varlistentry>
661
662<varlistentry id="esmtpd-msa">
663<term><command>esmtpd-msa</command></term>
[c6301dc]664<listitem><para>is a control script for courieresmtpd, but adds message
[ebe1291]665submission port 587 for the <acronym>MSA</acronym> protocol.</para>
666<indexterm zone="courier-package esmtpd-msa">
667<primary sortas="b-esmtpd-msa">esmtpd-msa</primary></indexterm>
668</listitem>
669</varlistentry>
670
671<varlistentry id="filterctl">
672<term><command>filterctl</command></term>
673<listitem><para>installs or uninstalls global mail filters.</para>
674<indexterm zone="courier-package filterctl">
675<primary sortas="b-filterctl">filterctl</primary></indexterm>
676</listitem>
677</varlistentry>
678
679<varlistentry id="imapd">
680<term><command>imapd</command></term>
[c6301dc]681<listitem><para>is the
682<application>Courier</application>-<acronym>IMAP</acronym>
683server.</para>
[ebe1291]684<indexterm zone="courier-package imapd">
685<primary sortas="b-imapd">imapd</primary></indexterm>
686</listitem>
687</varlistentry>
688
689<varlistentry id="lockmail">
690<term><command>lockmail</command></term>
[c6301dc]691<listitem><para>is a helper utility for locking mailbox files.</para>
[ebe1291]692<indexterm zone="courier-package lockmail">
693<primary sortas="b-lockmail">lockmail</primary></indexterm>
694</listitem>
695</varlistentry>
696
697<varlistentry id="mailbot">
698<term><command>mailbot</command></term>
[c6301dc]699<listitem><para>is a <acronym>MIME</acronym>-aware autoresponder utility.</para>
[ebe1291]700<indexterm zone="courier-package mailbot">
701<primary sortas="b-mailbot">mailbot</primary></indexterm>
702</listitem>
703</varlistentry>
704
705<varlistentry id="maildiracl">
706<term><command>maildiracl</command></term>
707<listitem><para>manages access control lists.</para>
708<indexterm zone="courier-package maildiracl">
709<primary sortas="b-maildiracl">maildiracl</primary></indexterm>
710</listitem>
711</varlistentry>
712
713<varlistentry id="maildirkw">
714<term><command>maildirkw</command></term>
[c6301dc]715<listitem><para>modifies
716<application>Courier</application>-<acronym>IMAP</acronym> compatible maildir
717message keywords.</para>
[ebe1291]718<indexterm zone="courier-package maildirkw">
719<primary sortas="b-maildirkw">maildirkw</primary></indexterm>
720</listitem>
721</varlistentry>
722
723<varlistentry id="maildirmake">
724<term><command>maildirmake</command></term>
725<listitem><para>creates maildirs, and maildir folders.</para>
726<indexterm zone="courier-package maildirmake">
727<primary sortas="b-maildirmake">maildirmake</primary></indexterm>
728</listitem>
729</varlistentry>
730
731<varlistentry id="maildrop">
732<term><command>maildrop</command></term>
[c6301dc]733<listitem><para>is a replacement local mail delivery agent that includes a
[ebe1291]734mail filtering language.</para>
735<indexterm zone="courier-package maildrop">
736<primary sortas="b-maildrop">maildrop</primary></indexterm>
737</listitem>
738</varlistentry>
739
740<varlistentry id="mailq-courier">
741<term><command>mailq</command></term>
742<listitem><para>displays a list of all messages that have not been
743delivered yet.</para>
744<indexterm zone="courier-package mailq-courier">
745<primary sortas="b-mailq">mailq</primary></indexterm>
746</listitem>
747</varlistentry>
748
749<varlistentry id="makeacceptmailfor">
750<term><command>makeacceptmailfor</command></term>
751<listitem><para>builds a list of domains to accept mail for, from the
752<filename class="directory">/etc/courier/esmtpacceptmailfor.dir</filename>
753directory.</para>
754<indexterm zone="courier-package makeacceptmailfor">
755<primary sortas="b-makeacceptmailfor">makeacceptmailfor</primary></indexterm>
756</listitem>
757</varlistentry>
758
759<varlistentry id="makealiases">
760<term><command>makealiases</command></term>
761<listitem><para>builds an alias database from one or more plain text
762source files.</para>
763<indexterm zone="courier-package makealiases">
764<primary sortas="b-makealiases">makealiases</primary></indexterm>
765</listitem>
766</varlistentry>
767
768<varlistentry id="makedat">
769<term><command>makedat</command></term>
[c6301dc]770<listitem><para>is a utility to create <application>GDBM</application> or
771<application>DB</application> files from plain text files.</para>
[ebe1291]772<indexterm zone="courier-package makedat">
773<primary sortas="b-makedat">makedat</primary></indexterm>
774</listitem>
775</varlistentry>
776
777<varlistentry id="makehosteddomains">
778<term><command>makehosteddomains</command></term>
779<listitem><para>rebuilds the contents of the hosteddomains database from the
780contents of <filename>/tools/etc/courier/hosteddomains</filename>.</para>
781<indexterm zone="courier-package makehosteddomains">
782<primary sortas="b-makehosteddomains">makehosteddomains</primary></indexterm>
783</listitem>
784</varlistentry>
785
786<varlistentry id="makemime">
787<term><command>makemime</command></term>
788<listitem><para>creates <acronym>MIME</acronym>-formatted messages from one
789or more files.</para>
790<indexterm zone="courier-package makemime">
791<primary sortas="b-makemime">makemime</primary></indexterm>
792</listitem>
793</varlistentry>
794
795<varlistentry id="makepercentrelay">
796<term><command>makepercentrelay</command></term>
797<listitem><para>builds a list of %-relayed domains from the
798<filename class="directory">percentrelay.dir</filename> directory.</para>
799<indexterm zone="courier-package makepercentrelay">
800<primary sortas="b-makepercentrelay">makepercentrelay</primary></indexterm>
801</listitem>
802</varlistentry>
803
804<varlistentry id="makesmtpaccess">
805<term><command>makesmtpaccess</command></term>
[c6301dc]806<listitem><para>builds <acronym>ESMTP</acronym> server access files from the
[ebe1291]807<filename class="directory">/etc/courier/smtpaccess</filename>
808directory.</para>
809<indexterm zone="courier-package makesmtpaccess">
810<primary sortas="b-makesmtpaccess">makesmtpaccess</primary></indexterm>
811</listitem>
812</varlistentry>
813
814<varlistentry id="makesmtpaccess-msa">
815<term><command>makesmtpaccess-msa</command></term>
[c6301dc]816<listitem><para>builds <acronym>ESMTP</acronym> server access files from the
[ebe1291]817<filename class="directory">/etc/courier/smtpaccess</filename> directory.
818This esmtp list is for the <acronym>MSA</acronym> protocol.</para>
819<indexterm zone="courier-package makesmtpaccess-msa">
820<primary sortas="b-makesmtpaccess-msa">makesmtpaccess-msa</primary></indexterm>
821</listitem>
822</varlistentry>
823
824<varlistentry id="makeuserdb">
825<term><command>makeuserdb</command></term>
[c6301dc]826<listitem><para>builds a user/password db from the contents
[ebe1291]827of <filename class="directory">/tools/etc/courier/userdb</filename>.</para>
828<indexterm zone="courier-package makeuserdb">
829<primary sortas="b-makeuserdb">makeuserdb</primary></indexterm>
830</listitem>
831</varlistentry>
832
833<varlistentry id="mimegpg">
834<term><command>mimegpg</command></term>
835<listitem><para>signs, encrypts, or decrypts <acronym>MIME</acronym>-formatted
836email messages using <application>GnuPG</application>.</para>
837<indexterm zone="courier-package mimegpg">
838<primary sortas="b-mimegpg">mimegpg</primary></indexterm>
839</listitem>
840</varlistentry>
841
842<varlistentry id="mkesmtpdcert">
843<term><command>mkesmtpdcert</command></term>
844<listitem><para>creates a secure <acronym>SMTP</acronym> test
845certificate.</para>
846<indexterm zone="courier-package mkesmtpdcert">
847<primary sortas="b-mkesmtpdcert">mkesmtpdcert</primary></indexterm>
848</listitem>
849</varlistentry>
850
851<varlistentry id="mkimapdcert">
852<term><command>mkimapdcert</command></term>
853<listitem><para>creates a secure <acronym>IMAP</acronym> test
854certificate.</para>
855<indexterm zone="courier-package mkimapdcert">
856<primary sortas="b-mkimapdcert">mkimapdcert</primary></indexterm>
857</listitem>
858</varlistentry>
859
860<varlistentry id="mkpop3dcert">
861<term><command>mkpop3dcert</command></term>
862<listitem><para>creates a secure <acronym>POP3</acronym> test
863certificate.</para>
864<indexterm zone="courier-package mkpop3dcert">
865<primary sortas="b-mkpop3dcert">mkpop3dcert</primary></indexterm>
866</listitem>
867</varlistentry>
868
869<varlistentry id="pop3d">
870<term><command>pop3d</command></term>
[c6301dc]871<listitem><para>is a wrapper script for <command>couriertcpd</command> to
[ebe1291]872start and stop the <acronym>POP3</acronym> service.</para>
873<indexterm zone="courier-package pop3d">
874<primary sortas="b-pop3d">pop3d</primary></indexterm>
875</listitem>
876</varlistentry>
877
878<varlistentry id="pop3d-ssl">
879<term><command>pop3d-ssl</command></term>
[c6301dc]880<listitem><para>is a wrapper script for <command>couriertcpd</command> to
[ebe1291]881start and stop the <acronym>POP3</acronym> over <acronym>SSL</acronym>
882service.</para>
883<indexterm zone="courier-package pop3d-ssl">
884<primary sortas="b-pop3d-ssl">pop3d-ssl</primary></indexterm>
885</listitem>
886</varlistentry>
887
888<varlistentry id="preline">
889<term><command>preline</command></term>
[c6301dc]890<listitem><para>prepends legacy <filename>mbox</filename> headers to mail
891messages.</para>
[ebe1291]892<indexterm zone="courier-package preline">
893<primary sortas="b-preline">preline</primary></indexterm>
894</listitem>
895</varlistentry>
896
897<varlistentry id="reformail">
898<term><command>reformail</command></term>
899<listitem><para>reads a message on standard input, reformats it in some
900way, and writes the message to standard output.</para>
901<indexterm zone="courier-package reformail">
902<primary sortas="b-reformail">reformail</primary></indexterm>
903</listitem>
904</varlistentry>
905
906<varlistentry id="reformime">
907<term><command>reformime</command></term>
[c6301dc]908<listitem><para>is a utility for reformatting <acronym>MIME</acronym>
909messages.</para>
[ebe1291]910<indexterm zone="courier-package reformime">
911<primary sortas="b-reformime">reformime</primary></indexterm>
912</listitem>
913</varlistentry>
914
915<varlistentry id="sendmail-courier">
916<term><command>sendmail</command></term>
[c6301dc]917<listitem><para>reads an email message and delivers the message to its
[ebe1291]918recipients.</para>
919<indexterm zone="courier-package sendmail-courier">
920<primary sortas="b-sendmail">sendmail</primary></indexterm>
921</listitem>
922</varlistentry>
923
924<varlistentry id="submit">
925<term><command>submit</command></term>
[c6301dc]926<listitem><para>submits messages to <application>Courier</application> for
[ebe1291]927processing.</para>
928<indexterm zone="courier-package submit">
929<primary sortas="b-submit">submit</primary></indexterm>
930</listitem>
931</varlistentry>
932
933<varlistentry id="testmxlookup">
934<term><command>testmxlookup</command></term>
935<listitem><para>lists the names and <acronym>IP</acronym> addresses of mail
936relays that receive mail for the domain.</para>
937<indexterm zone="courier-package testmxlookup">
938<primary sortas="b-testmxlookup">testmxlookup</primary></indexterm>
939</listitem>
940</varlistentry>
941
942<varlistentry id="userdb">
943<term><command>userdb</command></term>
[c6301dc]944<listitem><para>is a script to individually manipulate entries in
[ebe1291]945<filename>/tools/etc/courier/userdb.</filename></para>
946<indexterm zone="courier-package userdb">
947<primary sortas="b-userdb">userdb</primary></indexterm>
948</listitem>
949</varlistentry>
950
951<varlistentry id="userdbpw">
952<term><command>userdbpw</command></term>
953<listitem><para>reads a single line of text on standard input, encrypts
954it, and prints the encrypted result to standard output.</para>
955<indexterm zone="courier-package userdbpw">
956<primary sortas="b-userdbpw">userdbpw</primary></indexterm>
957</listitem>
958</varlistentry>
959</variablelist>
[f45b1953]960
[0931098]961</sect2>
[7ee9849]962
[f45b1953]963</sect1>
964
Note: See TracBrowser for help on using the repository browser.