Rombobjörn

summaryrefslogtreecommitdiff
path: root/test/README
diff options
context:
space:
mode:
Diffstat (limited to 'test/README')
-rw-r--r--test/README5
1 files changed, 5 insertions, 0 deletions
diff --git a/test/README b/test/README
new file mode 100644
index 0000000..466b30a
--- /dev/null
+++ b/test/README
@@ -0,0 +1,5 @@
+This test milter can be used to test the Ada Milter API.
+
+To ensure that the test milter won't affect the delivery of regular email, it will only process messages from SMTP clients on the local host, and only those where the string "Ada_Milter_API_test_milter" occurs somewhere in a recipient address. "Ada_Milter_API_test_milter" may for example be the name of an email account, or a part of the account name, or it may be included as an address extension, as in "account+Ada_Milter_API_test_milter@domain.example", if the MTA supports address extensions.
+
+The test milter creates a Unix domain socket named /var/spool/test_milter/milter_socket. The directory /var/spool/test_milter must already exist, with write permission for the test milter and search permission for the MTA. The directory may be a symbolic link if the socket needs to be in some other directory.