add action store to documentation

This commit is contained in:
2020-06-17 16:40:20 +02:00
parent 3a97b649e0
commit 55bbc5a2b7
2 changed files with 28 additions and 3 deletions

View File

@@ -63,6 +63,7 @@ Config options for **action** objects:
* **del_header** * **del_header**
* **mod_header** * **mod_header**
* **add_disclaimer** * **add_disclaimer**
* **store**
* **conditions** (optional) * **conditions** (optional)
A list of conditions which all have to be true to process the action. A list of conditions which all have to be true to process the action.
* **pretend** (optional) * **pretend** (optional)
@@ -101,14 +102,22 @@ Config options for **add_disclaimer** actions:
Path to a file which contains the text representation of the disclaimer. Path to a file which contains the text representation of the disclaimer.
* **error_policy** (optional) * **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: 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. 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. Ignore the error and do nothing.
* reject * **reject**
Reject the e-mail. Reject the e-mail.
Default: **wrap** 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 ### Conditions
Config options for **conditions** objects: Config options for **conditions** objects:

View File

@@ -191,6 +191,22 @@
# Value: [ wrap | ignore | reject ] # Value: [ wrap | ignore | reject ]
# #
"error_policy": "wrap" "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"
} }
] ]
} }