summaryrefslogtreecommitdiffstats
path: root/maildrop/README.html.in
blob: 1aafa42d9491a9d5ff0ce23cfad48ba4b5ff1399 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content=
  "text/html; charset=utf-8" />

  <title>maildrop - mail delivery agent with filtering
  abilities</title>
  <meta name="MSSmartTagsPreventParsing" content="TRUE" />
  <link rel="icon" href="icon.gif" type="image/gif" />
</head>

<body text="#000000" bgcolor="#FFFFFF" link="#0000EF" vlink=
"#51188E" alink="#FF0000">
  <!-- Copyright 1998 - 2008 Double Precision, Inc.  See COPYING for -->
  <!-- distribution information. -->

  <h1>maildrop - mail delivery agent with filtering
  abilities</h1>Current development version is @VERSION@, stable
  version is @PREVIOUS_VERSION@.

  <p>Copyright 1998-2008, Double Precision Inc.</p>

  <p>This program is distributed under the terms of the GNU General
  Public License. See <code>COPYING</code> for additional
  information.</p>

  <h2>Where to find <em>maildrop</em></h2>Join the maildrop mailing
  list - <code><a href=
  "http://lists.sourceforge.net/lists/listinfo/courier-maildrop">http://lists.sourceforge.net/lists/listinfo/courier-maildrop</a></code>.

  <p>I've started a list of "<a href="maildroptips.html">tips and
  tricks</a>" for writing mail filters with maildrop.</p>

  <p>The HTML version of the <em>maildrop</em> README is located at
  <code>http://www.courier-mta.org/maildrop/</code>. Although the
  following files may also be found there, please check your
  favorite archive for any local copies:</p>

  <div align="center">
    <table border="1" cellpadding="5" width="80%" bgcolor=
    "#CCCCCC">
      <tbody>
        <tr>
          <td>
            <p>The STABLE version of maildrop:</p>

            <p><code><a href=
            "maildrop-@PREVIOUS_VERSION@.tar.gz">maildrop-@PREVIOUS_VERSION@.tar.gz</a></code>
            - the source code tarball.</p>

            <p><code><a href=
            "maildrop-@PREVIOUS_VERSION@-1.src.rpm">maildrop-@PREVIOUS_VERSION@-1.src.rpm</a></code>-
            the distribution source code in the RPM format. To
            build a binary RPM run the command <code>rpm --rebuild
            maildrop-@PREVIOUS_VERSION@-1.src.rpm</code>.</p>

            <p><code><a href=
            "maildrop-@PREVIOUS_VERSION@-1.i386.rpm">maildrop-@PREVIOUS_VERSION@-1.i386.rpm</a></code>
            - pre-built binary RPM for Red Hat Linux. Please note
            that the binary RPM's configuration includes the
            <code>--enable-restrict-trusted=0</code> flag: a
            relaxed security level which allows all users to use
            the -d option to <em>maildrop</em>. <em>Maildrop</em>'s
            default, strict, security model may result in sendmail
            temporarily deferring local mail (it will be eventually
            delivered). See <code><a href=
            "INSTALL.html">INSTALL</a></code> for more information.
            If your system does not require relaxed security, you
            may rebuild the source RPM (after making the
            appropriate adjustment to the .spec file).</p>
            <hr width="80%" />

            <p>The DEVELOPMENT version of maildrop:</p>

            <p><code><a href=
            "maildrop-@VERSION@.tar.gz">maildrop-@VERSION@.tar.gz</a></code></p>

            <p><code><a href=
            "maildrop-@VERSION@-1.src.rpm">maildrop-@VERSION@-1.src.rpm</a></code></p>

            <p><code><a href=
            "maildrop-@VERSION@-1.i386.rpm">maildrop-@VERSION@-1.i386.rpm</a></code></p>
          </td>
        </tr>
      </tbody>
    </table>
  </div>

  <p>The RPMs are signed with my GnuPG key: <code><a href=
  "http://www.courier-mta.org/KEYS.bin">http://www.courier-mta.org/KEYS.bin</a></code>.</p>

  <p><em>maildrop</em> includes documentation in HTML, as well as
  traditional man pages. The HTML versions may also be found at
  <code><a href=
  "maildrop.html">http://www.courier-mta.org/maildrop/maildrop.html</a>.</code></p>

  <h2>Introduction</h2>

  <p><em>maildrop</em> is a replacement for your local mail
  delivery agent. <em>maildrop</em> reads a mail message from
  standard input, then delivers the message to your mailbox.
  <em>maildrop</em> knows how to deliver mail to mbox-style
  mailboxes, and maildirs.</p>

  <p><em>maildrop</em> will optionally read instructions from a
  file, which describes how to filter incoming mail. Instructions
  can be provided having mail delivered to alternate mailboxes, or
  forwarded somewhere else. Unlike procmail, <em>maildrop</em> uses
  a structured filtering language.</p>

  <p><em>maildrop</em> is written in C++, and is significantly
  larger than procmail in compiled form. However, it uses resources
  much more efficiently. Unlike procmail, <em>maildrop</em> will
  not read a 10 megabyte mail message into memory. Large messages
  are saved in a temporary file, and are filtered from the
  temporary file. Temporary files are saved in the user's home
  directory. If the standard input to <em>maildrop</em> is a file,
  and not a pipe, a temporary file will not be necessary.</p>

  <p><em>maildrop</em> checks the syntax of the mail delivery
  instructions the filter file, before attempting to deliver a
  message. Unlike procmail, if the filter file contains syntax
  errors, <em>maildrop</em> terminates without delivering the
  message. The user can fix the typo without causing any mail to be
  lost.</p>

  <h2>Installation</h2>See <code><a href=
  "INSTALL.html">INSTALL</a></code> for installation information.
  If you are using an RPM-based GNU/Linux distribution, you can
  install the binary RPM (see above), or rebuild the source RPM.

  <h2>Maildrop mailing list</h2>

  <p>Subscribe to the maildrop mailing list at <a target="_blank"
  href=
  "http://lists.sourceforge.net/mailman/listinfo/courier-maildrop">http://lists.sourceforge.net/mailman/listinfo/courier-maildrop</a>,
  or send a message to
  <code>&lt;courier-maildrop-request</code><code>@lists.sourceforge.net&gt;</code>
  and put "subscribe" in the subject line. Search the list archives
  at <a target="_blank" href=
  "http://markmail.org/browse/net.sourceforge.lists.courier-maildrop">
  http://markmail.org/browse/net.sourceforge.lists.courier-maildrop</a>.</p>
</body>
</html>