source: server/mail/courier.xml@ 3cb0c57

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 3cb0c57 was 3cb0c57, checked in by Randy McMurchy <randy@…>, 18 years ago

Added the 'User Notes' wiki link to each package page; changed all instances of .[so,a] to .{so,a} (brackets changed to braces); changed all replaceable tags to use angle brackets instead of square brackets to encapsulate the text - commit #9

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