From 55bbc5a2b70092507771abb5ea65c9e0d01d1123 Mon Sep 17 00:00:00 2001
From: Thomas Oettli <spacefreak@noop.ch>
Date: Wed, 17 Jun 2020 16:40:20 +0200
Subject: [PATCH] add action store to documentation

---
 README.md                     | 15 ++++++++++++---
 docs/pymodmilter.conf.example | 16 ++++++++++++++++
 2 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e103d79..86bdb5e 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,7 @@ Config options for **action** objects:
   * **del_header**
   * **mod_header**
   * **add_disclaimer**
+  * **store**
 * **conditions** (optional)  
   A list of conditions which all have to be true to process the action.
 * **pretend** (optional)  
@@ -101,14 +102,22 @@ Config options for **add_disclaimer** actions:
     Path to a file which contains the text representation of the disclaimer.
   * **error_policy** (optional)  
     Set the error policy in case the disclaimer cannot be added (e.g. if no body part is present in the e-mail). Possible values are:
-    * wrap  
+    * **wrap**  
       A new e-mail body is generated with the disclaimer as body and the original e-mail attached.
-    * ignore  
+    * **ignore**  
       Ignore the error and do nothing.
-    * reject  
+    * **reject**  
       Reject the e-mail.
     Default: **wrap**
 
+Config options for **store** actions:
+  * **storage_type**  
+    Storage type. Possible values are:
+    * **file**
+
+Config options for **file** storage:
+  * **directory**  
+  Directory used to store e-mails.
 
 ### Conditions
 Config options for **conditions** objects:
diff --git a/docs/pymodmilter.conf.example b/docs/pymodmilter.conf.example
index 9760544..04e887f 100644
--- a/docs/pymodmilter.conf.example
+++ b/docs/pymodmilter.conf.example
@@ -191,6 +191,22 @@
                     # Value:  [ wrap | ignore | reject ]
                     #
                     "error_policy": "wrap"
+                }, {
+                    "name": "store_message",
+
+                    "type": "store",
+
+                    # Option: storage_type
+                    # Type:   String
+                    # Notes:  The storage type used to store e-mails.
+                    # Value: [ file ]
+                    "storage_type": "file",
+
+                    # Option: directory
+                    # Type:   String
+                    # Notes:  Directory used to store e-mails.
+                    # Value: [ file ]
+                    "directory": "/mnt/messages"
                 }
             ]
         }