spacefreak/pyquarantine-milter
1
0
Fork 0
Code Issues Pull Requests Releases Activity

change README.md

Browse Source
This commit is contained in:
Thomas Oettli
2022-01-11 18:38:01 +01:00
parent a7606e1813
commit f66bbbc45d
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -74,9 +74,9 @@ Config options for action objects:
* **name** * **name**
Name of the action. Name of the action.
* **type** * **type**
See section [Actions](#Actions). See section [Action types](#Action-types).
* **options** * **options**
Options depending on the action type, see section [Actions](#Actions). Options depending on the action type, see section [Action types](#Action-types).
* **conditions** (optional) * **conditions** (optional)
See section [Conditions](#Conditions). See section [Conditions](#Conditions).
* **loglevel** (optional) * **loglevel** (optional)
@@ -107,9 +107,9 @@ Config options for conditions objects:
### Whitelist ### Whitelist
Config options for whitelist objects: Config options for whitelist objects:
* **type** * **type**
See section [Whitelists](#Whitelists). See section [Whitelist types](#Whitelist-types).
### Actions ### Action types
Available action types: Available action types:
##### add_header ##### add_header
Add new header. Add new header.
@@ -165,7 +165,7 @@ Options:
Store e-mail. Store e-mail.
Options: Options:
* **type** * **type**
See section [Storages](#Storages). See section [Storage types](#Storage-types).
* **original** (optional, default: false) * **original** (optional, default: false)
If set to true, store the message as received by the MTA instead of storing the current state of the message, that may was modified already by other actions. If set to true, store the message as received by the MTA instead of storing the current state of the message, that may was modified already by other actions.
* **metadata** (optional, default: false) * **metadata** (optional, default: false)
@@ -187,14 +187,14 @@ Options:
Quarantine e-mail. Quarantine e-mail.
Options: Options:
* **store** * **store**
Options for e-mail storage, see action **store** in section [Actions](#Actions). Options for e-mail storage, see action **store** in section [Action types](#Action-types).
If the option **metadata** is not specificall set for this storage, it will be set to true. If the option **metadata** is not specificall set for this storage, it will be set to true.
* **smtp_host** * **smtp_host**
SMTP host used to release e-mails from quarantine. SMTP host used to release e-mails from quarantine.
* **smtp_port** * **smtp_port**
SMTP port used to release e-mails from quarantine. SMTP port used to release e-mails from quarantine.
* **notify** (optional) * **notify** (optional)
Options for e-mail notifications, see action **notify** in section [Actions](#Actions). Options for e-mail notifications, see action **notify** in section [Action types](#Action-types).
* **milter_action** (optional) * **milter_action** (optional)
Final milter action to perform. If set, no further rules or actions will be processed. Final milter action to perform. If set, no further rules or actions will be processed.
Possible values: Possible values:
@@ -206,7 +206,7 @@ Options:
* **whitelist** (optional) * **whitelist** (optional)
Options for a whitelist, see **whitelist** in section [Conditions](#Conditions). Options for a whitelist, see **whitelist** in section [Conditions](#Conditions).
### Storages ### Storage types
Available storage types: Available storage types:
##### file ##### file
File storage. File storage.
@@ -240,7 +240,7 @@ Options:
* **embed_imgs** (optional) * **embed_imgs** (optional)
List of images to embed into the notification e-mail. List of images to embed into the notification e-mail.
### Whitelists ### Whitelist types
Available whitelist types: Available whitelist types:
##### db ##### db
Whitelist stored in database. The table is created automatically if it does not exist yet. Whitelist stored in database. The table is created automatically if it does not exist yet.