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 17:09:51 +01:00
parent f840f0c7a7
commit 9eb571b135
1 changed files with 25 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -48,7 +48,7 @@ Global config options:
List of rule objects. List of rule objects.
### Rule ### Rule
Rule config options: Config options for rule objects:
* **name** * **name**
Name of the rule. Name of the rule.
* **actions** * **actions**
@@ -61,7 +61,7 @@ Rule config options:
See section [Global](#Global). See section [Global](#Global).
### Action ### Action
Action config options: Config options for action objects:
* **name** * **name**
Name of the action. Name of the action.
* **type** * **type**
@@ -76,7 +76,7 @@ Action config options:
See section [Global](#Global). See section [Global](#Global).
### Conditions ### Conditions
Config options for **conditions** objects: Config options for conditions objects:
* **local** (optional) * **local** (optional)
Matches outgoing e-mails (sender address matches **local_addrs**) if set to **true** or matches incoming e-mails if set to **false**. Matches outgoing e-mails (sender address matches **local_addrs**) if set to **true** or matches incoming e-mails if set to **false**.
* **hosts** (optional) * **hosts** (optional)
@@ -96,28 +96,31 @@ Config options for **conditions** objects:
If not set, no metavariables will be provided. If not set, no metavariables will be provided.
### Whitelist ### Whitelist
Config options for **whitelist** objects: Config options for whitelist objects:
* **type** * **type**
See section [Whitelists](#Whitelists). See section [Whitelists](#Whitelists).
### Actions ### Actions
The following action types and options are available. The following action types and options are available.
* **add_header** * **add_header**
Add new header. Add new header.
Options:
* **field** * **field**
Name of the header. Name of the header.
* **value** * **value**
Value of the header. Value of the header.
* **del_header** * **del_header**
Delete header(s). Delete header(s).
Options:
* **field** * **field**
Regular expression to match against header names. Regular expression to match against header names.
* **value** (optional) * **value** (optional)
Regular expression to match against the headers value. Regular expression to match against the headers value.
* **mod_header** * **mod_header**
Modify header(s). Modify header(s).
Options:
* **field** * **field**
Regular expression to match against header names. Regular expression to match against header names.
* **search** (optional) * **search** (optional)
@@ -126,7 +129,8 @@ The following action types and options are available.
New value of the header. New value of the header.
* **add_disclaimer** * **add_disclaimer**
Append or prepend disclaimer to text and/or html body parts. Append or prepend disclaimer to text and/or html body parts.
Options:
* **action** * **action**
Action to perform with the disclaimer. Action to perform with the disclaimer.
Possible values: Possible values:
@@ -149,7 +153,8 @@ The following action types and options are available.
Generate a html body with the content of the text body if no html body is present. Generate a html body with the content of the text body if no html body is present.
* **store** * **store**
Store e-mail. Store e-mail.
Options:
* **type** * **type**
See section [Storages](#Storages). See section [Storages](#Storages).
* **original** (optional, default: **false**) * **original** (optional, default: **false**)
@@ -164,12 +169,14 @@ The following action types and options are available.
* **METAFILE** (path to the meta file if **metadata** is set to **true**) * **METAFILE** (path to the meta file if **metadata** is set to **true**)
* **notify** * **notify**
Send notification to receiver. Send notification.
Options:
* **type** * **type**
See section [Notifications](#Notifications). See section [Notifications](#Notifications).
* **quarantine** * **quarantine**
Quarantine e-mail. Quarantine e-mail.
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 [Actions](#Actions).
* **smtp_host** * **smtp_host**
@@ -192,6 +199,8 @@ The following action types and options are available.
### Storages ### Storages
The following storage types are and options are available: The following storage types are and options are available:
* **file** * **file**
File storage.
Options:
* **directory** * **directory**
Directory used to store e-mails. Directory used to store e-mails.
* **metadata** (optional, default: **false**) * **metadata** (optional, default: **false**)
@@ -201,7 +210,9 @@ The following storage types are and options are available:
### Notifications ### Notifications
The following notification types and options are available: The following notification types and options are available:
* **email** * **email**
E-Mail notification.
Options:
* **smtp_host** * **smtp_host**
SMTP host used to send notifications. SMTP host used to send notifications.
* **smtp_port** * **smtp_port**
@@ -222,7 +233,8 @@ The following notification types and options are available:
### Whitelists ### Whitelists
The following whitelist types and options are available. The following whitelist types and options are available.
* **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.
Options:
* **connection** * **connection**
Database connection string, see [Peewee Playhouse Extension](https://docs.peewee-orm.com/en/latest/peewee/playhouse.html#db-url). Database connection string, see [Peewee Playhouse Extension](https://docs.peewee-orm.com/en/latest/peewee/playhouse.html#db-url).
* **table** * **table**