source: server/mail/courier.xml@ 5254d12

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.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 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/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 5254d12 was 5254d12, checked in by Randy McMurchy <randy@…>, 18 years ago

Standardized the id tag name of the Bootscripts package

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

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