change README.md
This commit is contained in:
71
README.md
71
README.md
@@ -76,9 +76,40 @@ Global config options:
|
|||||||
* **debug**
|
* **debug**
|
||||||
* **pretend** (optional, default: false)
|
* **pretend** (optional, default: false)
|
||||||
Pretend actions, for test purposes. This option may be overriden by any rule or action object.
|
Pretend actions, for test purposes. This option may be overriden by any rule or action object.
|
||||||
|
* **storages**
|
||||||
|
Object containing Storage objects.
|
||||||
|
* **notifications**
|
||||||
|
Object containing Notification objects.
|
||||||
|
* **lists**
|
||||||
|
Object containing List objects.
|
||||||
* **rules**
|
* **rules**
|
||||||
List of rule objects.
|
List of rule objects.
|
||||||
|
|
||||||
|
### Storage
|
||||||
|
Config options for Storage objects:
|
||||||
|
* **type**
|
||||||
|
See section [Storage types](#Storage-types).
|
||||||
|
* **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.
|
||||||
|
* **metadata** (optional, default: false)
|
||||||
|
Store metadata.
|
||||||
|
* **metavar** (optional)
|
||||||
|
Prefix for the metavariable names. If not set, no metavariables will be provided.
|
||||||
|
The storage provides the following metavariables:
|
||||||
|
* **ID** (the storage ID of the e-mail)
|
||||||
|
* **DATAFILE** (path to the data file)
|
||||||
|
* **METAFILE** (path to the meta file if **metadata** is set to **true**)
|
||||||
|
|
||||||
|
### Notification
|
||||||
|
Config options for Notification objects:
|
||||||
|
* **type**
|
||||||
|
See section [Notification types](#Notification-types).
|
||||||
|
|
||||||
|
### List
|
||||||
|
Config options for List objects:
|
||||||
|
* **type**
|
||||||
|
See section [List types](#List-types).
|
||||||
|
|
||||||
### Rule
|
### Rule
|
||||||
Config options for rule objects:
|
Config options for rule objects:
|
||||||
* **name**
|
* **name**
|
||||||
@@ -119,19 +150,14 @@ Config options for conditions objects:
|
|||||||
Matches e-mails for which all envelope-to addresses match the given regular expression.
|
Matches e-mails for which all envelope-to addresses match the given regular expression.
|
||||||
* **headers** (optional)
|
* **headers** (optional)
|
||||||
Matches e-mails for which all regular expressions in the given list are matching at least one e-mail header.
|
Matches e-mails for which all regular expressions in the given list are matching at least one e-mail header.
|
||||||
* **allowlist** (optional)
|
* **list** (optional)
|
||||||
Matches e-mails for which the allowlist has no entry for the envelope-from and envelope-to address combination, see section [Allowlist](#Allowlist) for details.
|
Matches e-mails for which the given list has an entry for the envelope-from and envelope-to address combination, see section [List](#List) for details.
|
||||||
* **var** (optional)
|
* **var** (optional)
|
||||||
Matches e-mails for which a previous action or condition has set the given metavariable.
|
Matches e-mails for which a previous action or condition has set the given metavariable.
|
||||||
* **metavar** (optional)
|
* **metavar** (optional)
|
||||||
Prefix for the name of metavariables which are possibly provided by the **envfrom**, **envto** or **headers** condition. Meta variables will be provided if the regular expressions contain named subgroups, see [python.re](https://docs.python.org/3/library/re.html) for details.
|
Prefix for the name of metavariables which are possibly provided by the **envfrom**, **envto** or **headers** condition. Meta variables will be provided if the regular expressions contain named subgroups, see [python.re](https://docs.python.org/3/library/re.html) for details.
|
||||||
If not set, no metavariables will be provided.
|
If not set, no metavariables will be provided.
|
||||||
|
|
||||||
### Allowlist
|
|
||||||
Config options for allowlist objects:
|
|
||||||
* **type**
|
|
||||||
See section [Allowlist types](#Allowlist-types).
|
|
||||||
|
|
||||||
### Action types
|
### Action types
|
||||||
Available action types:
|
Available action types:
|
||||||
##### add_header
|
##### add_header
|
||||||
@@ -187,37 +213,27 @@ Options:
|
|||||||
##### store
|
##### store
|
||||||
Store e-mail.
|
Store e-mail.
|
||||||
Options:
|
Options:
|
||||||
* **type**
|
* **storage**
|
||||||
See section [Storage types](#Storage-types).
|
Index of a Storage object in the global storages object.
|
||||||
* **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.
|
|
||||||
* **metadata** (optional, default: false)
|
|
||||||
Store metadata.
|
|
||||||
* **metavar** (optional)
|
|
||||||
Prefix for the metavariable names. If not set, no metavariables will be provided.
|
|
||||||
The storage provides the following metavariables:
|
|
||||||
* **ID** (the storage ID of the e-mail)
|
|
||||||
* **DATAFILE** (path to the data file)
|
|
||||||
* **METAFILE** (path to the meta file if **metadata** is set to **true**)
|
|
||||||
|
|
||||||
##### notify
|
##### notify
|
||||||
Send notification.
|
Send notification.
|
||||||
Options:
|
Options:
|
||||||
* **type**
|
* **notification**
|
||||||
See section [Notification types](#Notification-types).
|
Index of a Notification object in the global notifications object.
|
||||||
|
|
||||||
##### quarantine
|
##### quarantine
|
||||||
Quarantine e-mail.
|
Quarantine e-mail.
|
||||||
Options:
|
Options:
|
||||||
* **store**
|
* **store**
|
||||||
Options for e-mail storage, see action [store](#store).
|
Index of a Storage object in the global storages object.
|
||||||
If the option **metadata** is not specificall set for this storage, it will be set to true.
|
If the option **metadata** is not specifically 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](#notify).
|
Index of a Notification object in the global notifications object.
|
||||||
* **milter_action** (optional)
|
* **milter_action** (optional)
|
||||||
Milter action to perform. If set, no further rules or actions will be processed.
|
Milter action to perform. If set, no further rules or actions will be processed.
|
||||||
Please think carefully what you set here or your MTA may do something you do not want it to do.
|
Please think carefully what you set here or your MTA may do something you do not want it to do.
|
||||||
@@ -231,7 +247,8 @@ Options:
|
|||||||
* **reject_reason** (optional, default: "Message rejected")
|
* **reject_reason** (optional, default: "Message rejected")
|
||||||
Reject message sent to MTA if milter_action is set to reject.
|
Reject message sent to MTA if milter_action is set to reject.
|
||||||
* **allowlist** (optional)
|
* **allowlist** (optional)
|
||||||
Options for a allowlist object, see section [Allowlist](#Allowlist).
|
Ignore e-mails for which the given list has an entry for the envelope-from and envelope-to address combination, see section [List](#List) for details.
|
||||||
|
If an e-mail as multiple recipients, the decision is made per recipient.
|
||||||
|
|
||||||
### Storage types
|
### Storage types
|
||||||
Available storage types:
|
Available storage types:
|
||||||
@@ -289,10 +306,10 @@ Options:
|
|||||||
* **embed_imgs** (optional)
|
* **embed_imgs** (optional)
|
||||||
List of images to embed into the notification e-mail. The Content-ID of each image will be set to the filename, so you can reference it from the e-mail template.
|
List of images to embed into the notification e-mail. The Content-ID of each image will be set to the filename, so you can reference it from the e-mail template.
|
||||||
|
|
||||||
### Allowlist types
|
### List types
|
||||||
Available list types:
|
Available list types:
|
||||||
##### db
|
##### db
|
||||||
Allowlist stored in database. The table is created automatically if it does not exist yet.
|
List stored in database. The table is created automatically if it does not exist yet.
|
||||||
Options:
|
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).
|
||||||
|
|||||||
Reference in New Issue
Block a user