summaryrefslogtreecommitdiffstats
path: root/doc/wiki/Pigeonhole.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/wiki/Pigeonhole.txt')
-rw-r--r--doc/wiki/Pigeonhole.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/wiki/Pigeonhole.txt b/doc/wiki/Pigeonhole.txt
new file mode 100644
index 0000000..7666b25
--- /dev/null
+++ b/doc/wiki/Pigeonhole.txt
@@ -0,0 +1,45 @@
+Pigeonhole Sieve support
+========================
+
+Introduction
+------------
+
+The <Pigeonhole project> [Pigeonhole.txt] provides mail filtering facilities at
+time of final message delivery using the Sieve (RFC 5228
+[https://www.ietf.org/rfc/rfc5228.txt]) language. By writing Sieve scripts,
+users can customize how messages are delivered, e.g. whether they are forwarded
+or stored in special folders. The Sieve language is meant to be simple,
+extensible and system independent. And, unlike most other mail filtering script
+languages, it does not allow users to execute arbitrary programs. This is
+particularly useful to prevent virtual users from having full access to the
+mail store. The intention of the language is to make it impossible for users to
+do anything more complex (and dangerous) than write simple mail filters. See
+Sieve wiki [https://sieve.info/] for more comprehensive information about the
+Sieve language itself.
+
+Installation
+------------
+
+Refer to the <installation page> [Pigeonhole.Installation.txt].
+
+Configuration and Use
+---------------------
+
+The Pigeonhole package provides the following items:
+
+ * The <Sieve interpreter plugin> [Pigeonhole.Sieve.txt] for Dovecot's <Local
+ Delivery Agent (LDA)> [LDA.txt] or its <LMTP.txt> server: This facilitates
+ the actual Sieve filtering upon delivery.
+ * The <ManageSieve Service> [Pigeonhole.ManageSieve.txt]: This implements the
+ ManageSieve protocol through which users can remotely manage Sieve scripts
+ on the server.
+
+Contact Info
+------------
+
+ * Author: Stephan Bosch, stephan@rename-it.nl
+ * IRC: Freenode [https://freenode.net/], #dovecot, S[r]us
+ * Please use the Dovecot mailing list [https://www.dovecot.org/mailing-lists]
+ for questions about the Pigeonhole. You don't have to subscribe to it.
+
+(This file was created from the wiki on 2019-06-19 12:42)