summaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..fee097e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,12 @@
+# SpamPD
+
+<span style="color: red">NOTE: please see Download section for official release versions. The repository version IS NOT THOUROUGHLY TESTED.</span>
+
+spampd is a program used within an e-mail delivery system to scan messages for possible Unsolicited Commercial E-mail (UCE, aka spam) content.
+It uses an excellent program called SpamAssassin (SA) to do the actual message scanning. spampd acts as a transparent SMTP/LMTP proxy between
+two mail servers, and during the transaction it passes the mail through SA. If SA decides the mail could be spam, then spampd will ask SA to
+add some headers and a report to the message indicating it's spam and why. spampd is written in Perl and should theoretically run on any
+platform supported by Perl and SpamAssassin.
+
+More information is available at <a href="http://www.worlddesign.com/index.cfm/page/rd/mta/spampd.htm">here</a>.
+