Rombobjörn

summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README27
1 files changed, 27 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..c285b32
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+ The Ada Milter API
+
+ The Ada Milter API is a binding to Libmilter, the Sendmail mail filtering
+ API. A milter is a daemon that assists a Mail Transfer Agent, such as
+ Sendmail or Postfix, in checking messages and deciding whether to accept,
+ reject or modify them. This binding lets you write milters in Ada.
+
+Compatibility
+
+ Version 1.1.1 of the Milter API is intended to match the version of
+ Libmilter that comes with Sendmail 8.13.8, where the value of SMFI_VERSION
+ is 2. It provides almost all of the features in that version of Libmilter,
+ but lacks features introduced in later versions. This version of the
+ Milter API has been used successfully with Postfix 2.3.8.
+
+Documentation
+
+ There is documentation in the form of comments in the package
+ specification. In addition to those you should probably read the Libmilter
+ documentation, which is available at Milter.org and is also included with
+ Sendmail.
+
+License
+
+ The Ada Milter API is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License version 3, as
+ published by the Free Software Foundation.