aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJohannes Berg <johannes@sipsolutions.net>2007-09-30 18:33:01 +0200
committerJohannes Berg <johannes@sipsolutions.net>2007-09-30 18:33:01 +0200
commit658e7fe97b059ebf893fc3f2656ee6f569a7fb9f (patch)
treefce3dc38f7de48eadc7cfba0c21c3440d6f3568b /README
parent94e5e07c847768a15157c183aaa3bcb914e1afc2 (diff)
downloaddovecot-antispam-658e7fe97b059ebf893fc3f2656ee6f569a7fb9f.tar.gz
dovecot-antispam-658e7fe97b059ebf893fc3f2656ee6f569a7fb9f.tar.xz
dovecot-antispam-658e7fe97b059ebf893fc3f2656ee6f569a7fb9f.zip
add configuration section to README
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
index 2715cc6..8f9c8a7 100644
--- a/README
+++ b/README
@@ -47,6 +47,41 @@ INSTALLATION
# mail_plugin_dir = /usr/lib/dovecot/modules/imap
}
+CONFIGURATION
+
+ Aside from the build-configuration done in the '.config' file, you have
+ the following run-time options (shown along with the default):
+
+ plugin {
+ ##################
+ # GENERIC OPTIONS
+
+ # mail signature (used with any backend requiring a signature)
+ antispam_signature = X-DSPAM-Signature
+
+ # semicolon-separated list of Trash folders (default unset i.e. none)
+ # antispam_trash =
+ # antispam_trash = trash;Trash;Deleted Items
+
+ # semicolon-separarted list of spam folders
+ # antispam_spam = SPAM
+
+ ###########################
+ # BACKEND SPECIFIC OPTIONS
+ #
+
+ # dspam-exec plugin:
+
+ # dspam binary
+ antispam_dspam_binary = /usr/bin/dspam
+
+ # semicolon-separated list of extra arguments to dspam
+ # (default unset i.e. none)
+ # antispam_dspam_args =
+ # antispam_dspam_args = --user;%u # % expansion done by dovecot
+ # antispam_dspam_args = --mode=teft
+ }
+
AUTHORS
Johannes Berg, Frank Cusack, Benedikt Boehm, Andreas Schneider