change README.md
This commit is contained in:
12
README.md
12
README.md
@@ -1,9 +1,9 @@
|
|||||||
# pyquarantine-milter
|
# pyquarantine-milter
|
||||||
A pymilter based sendmail/postfix pre-queue filter with the ability to quarantine e-mails, send notifications and modify e-mail headers and/or bodies.
|
A pymilter based sendmail/postfix pre-queue filter with the ability to quarantine e-mails, send notifications and modify e-mail headers and/or bodies.
|
||||||
The project is currently in beta status, but it is already used in a productive enterprise environment that processes about a million e-mails per month.
|
|
||||||
|
|
||||||
It is useful in many cases due to its flexible configuration and the ability to handle any number of quarantines and/or modifications sequential and conditional.
|
It is useful in many cases due to its flexible configuration and the ability to handle any number of quarantines and/or modifications sequential and conditional.
|
||||||
|
|
||||||
|
The project is currently in beta status, but it is already used in a productive enterprise environment that processes about a million e-mails per month.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
pyquarantine is depending on these python packages, they are installed automatically if you are working with pip.
|
pyquarantine is depending on these python packages, they are installed automatically if you are working with pip.
|
||||||
* [jsonschema](https://github.com/Julian/jsonschema)
|
* [jsonschema](https://github.com/Julian/jsonschema)
|
||||||
@@ -101,7 +101,7 @@ Config options for whitelist objects:
|
|||||||
See section [Whitelists](#Whitelists).
|
See section [Whitelists](#Whitelists).
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
The following action types and options are available.
|
Available action types:
|
||||||
* **add_header**
|
* **add_header**
|
||||||
Add new header.
|
Add new header.
|
||||||
Options:
|
Options:
|
||||||
@@ -197,7 +197,7 @@ The following action types and options are available.
|
|||||||
Options for a whitelist, see **whitelist** in section [Conditions](#Conditions).
|
Options for a whitelist, see **whitelist** in section [Conditions](#Conditions).
|
||||||
|
|
||||||
### Storages
|
### Storages
|
||||||
The following storage types are and options are available:
|
Available storage types:
|
||||||
* **file**
|
* **file**
|
||||||
File storage.
|
File storage.
|
||||||
Options:
|
Options:
|
||||||
@@ -209,7 +209,7 @@ The following storage types are and options are available:
|
|||||||
File mode when new files are created.
|
File mode when new files are created.
|
||||||
|
|
||||||
### Notifications
|
### Notifications
|
||||||
The following notification types and options are available:
|
Available notification types:
|
||||||
* **email**
|
* **email**
|
||||||
E-Mail notification.
|
E-Mail notification.
|
||||||
Options:
|
Options:
|
||||||
@@ -231,7 +231,7 @@ The following notification types and options are available:
|
|||||||
List of images to embed into the notification e-mail.
|
List of images to embed into the notification e-mail.
|
||||||
|
|
||||||
### Whitelists
|
### Whitelists
|
||||||
The following whitelist types and options are available.
|
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.
|
||||||
Options:
|
Options:
|
||||||
|
|||||||
Reference in New Issue
Block a user