From 709c2627e82d61ecbf2eb40c7ebbe669aebaf31d Mon Sep 17 00:00:00 2001
From: rswindell <>
Date: Sat, 4 Oct 2008 22:11:43 +0000
Subject: [PATCH] Updated comments (with instructions).

---
 exec/mailproc_example.js | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/exec/mailproc_example.js b/exec/mailproc_example.js
index 4621794a8c..8027505c73 100644
--- a/exec/mailproc_example.js
+++ b/exec/mailproc_example.js
@@ -1,9 +1,22 @@
 // mailproc_example.js
 
+// $Id$
+
 // Example SMTP "Mail Processor" module
 // Requires Synchronet Mail Server 1.298 or later
 
-// $Id$
+// This script modifies the body text of an incoming message.
+// It adds all the recipient properties and RFC822 headers to the body text.
+
+// Configure in your ctrl/mailproc.ini file like so:
+
+// [mailproc_example.js]
+//  to = sysop, 1
+//	passthru = true
+
+// And then the body text of all messages received for "sysop" or user #1 will be modified
+
+// See ctrl/mailproc.ini for more details.
 
 load("mailproc_util.js");
 
-- 
GitLab