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

make the config example minimalistic

Browse Source
This commit is contained in:
Thomas Oettli
2021-10-08 15:58:54 +02:00
parent 8307277718
commit f3cbb8f6bf
1 changed files with 23 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

210
pyquarantine/misc/pyquarantine.conf.example
View File

@@ -1,15 +1,10 @@
# This is an example /etc/pyquarantine/pyquarantine.conf file. # This is an example /etc/pyquarantine/pyquarantine.conf file.
# Copy it into place before use. # Copy it into place and edit before use.
# #
# The file is in JSON format, but comments are allowed. # The file is in JSON format but comments are allowed.
# #
{ {
# Section: global # Option: socket (optional)
# Notes: Global options.
#
"global": {
# Option: socket
# Type: String
# Notes: The socket used to communicate with the MTA. # Notes: The socket used to communicate with the MTA.
# #
# Examples: # Examples:
@@ -18,202 +13,21 @@
# inet:8899@localhost listen on a specific interface # inet:8899@localhost listen on a specific interface
# inet6:8899 listen on ANY interface # inet6:8899 listen on ANY interface
# inet6:8899@[2001:db8:1234::1] listen on a specific interface # inet6:8899@[2001:db8:1234::1] listen on a specific interface
# Value: [ SOCKET ] #
"socket": "inet:8898@127.0.0.1", "socket": "inet:8898@127.0.0.1",
# Option: local_addrs # Option: local_addrs (optional)
# Type: List
# Notes: A list of local hosts and networks. # Notes: A list of local hosts and networks.
# Value: [ LIST ]
# #
"local_addrs": ["fe80::/64", "::1/128", "127.0.0.0/8", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"], #"local_addrs": ["fe80::/64", "::1/128", "127.0.0.0/8", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"],
# Option: loglevel # Option: loglevel (optional)
# Type: String # Notes: The default loglevel.
# Notes: Set loglevel for rules and actions.
# Value: [ error | warning | info | debug ]
# #
"loglevel": "info", #"loglevel": "info",
# Option: pretend # Option: rules
# Type: Bool # Notes: List of rules.
# Notes: Just pretend to do the actions, for test purposes.
# Value: [ true | false ]
# #
"pretend": true "rules": []
},
# Section: rules
# Notes: Rules and related actions.
#
"rules": [
{
# Option: name
# Type: String
# Notes: Name of the rule.
# Value: [ NAME ]
#
"name": "myrule",
# Section: conditions
# Notes: Optional conditions to process the rule.
# If multiple conditions are set, they all
# have to be true for the rule to be processed.
#
"conditions": {
# Option: local
# Type: Bool
# Notes: Condition wheter the senders host address is listed in local_addrs.
# Value: [ true | false ]
#
"local": false,
# Option: hosts
# Type: String
# Notes: Condition wheter the senders host address is listed in this list.
# Value: [ LIST ]
#
"hosts": [ "127.0.0.1" ],
# Option: envfrom
# Type: String
# Notes: Condition wheter the envelop-from address matches this regular expression.
# Value: [ REGEX ]
#
"envfrom": "^.+@mypartner\\.com$",
# Option: envto
# Type: String
# Notes: Condition wheter the envelop-to address matches this regular expression.
# Value: [ REGEX ]
#
"envto": "^postmaster@.+$"
},
# Section: actions
# Notes: Actions of the rule.
#
"actions": [
{
# Option: name
# Type: String
# Notes: Name of the modification.
# Value: [ NAME ]
#
"name": "add_test_header",
# Option: type
# Type: String
# Notes: Type of the modification.
# Value: [ add_header | del_header | mod_header ]
#
"type": "add_header",
# Option: field
# Type: String
# Notes: Name of the header.
# Value: [ NAME ]
#
"field": "X-Test-Header",
# Option: value
# Type: String
# Notes: Value of the header.
# Value: [ VALUE ]
#
"value": "true"
}, {
"name": "modify_subject",
"type": "mod_header",
# Option: field
# Type: String
# Notes: Regular expression to match against header lines (e.g. Subject: Test-Subject).
# Value: [ REGEX ]
#
"field": "^Subject$",
# Option: search
# Type: String
# Notes: Regular expression to match against the headers value.
# Values: [ VALUE ]
#
"search": "(?P<subject>.*)",
# Option: value
# Type: String
# Notes: New value of the header.
# Values: [ VALUE ]
"value": "[EXTERNAL] \\g<subject>"
}, {
"name": "delete_received_header",
"type": "del_header",
# Option: field
# Type: String
# Notes: Regular expression to match against header lines (e.g. Subject: Test-Subject).
# Value: [ REGEX ]
#
"field": "^Received$"
}, {
"name": "add_disclaimer",
"type": "add_disclaimer",
# Option: action
# Type: String
# Notes: Action to perform with the disclaimer.
# Value: [ append | prepend ]
#
"action": "prepend",
# Option: html_template
# Type: String
# Notes: Path to a file which contains the html representation of the disclaimer.
# Value: [ FILE_PATH ]
#
"html_template": "/etc/pyquarantine/templates/disclaimer_html.template",
# Option: text_template
# Type: String
# Notes: Path to a file which contains the text representation of the disclaimer.
# Value: [ FILE_PATH ]
#
"text_template": "/etc/pyquarantine/templates/disclaimer_text.template",
# Option: error_policy
# Type: String
# Notes: Set what should be done if the modification fails (e.g. no message body present).
# Value: [ wrap | ignore | reject ]
#
"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",
# Option: original
# Type: Bool
# Notes: 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.
# Value: [ true | false ]
"original": true
}
]
}
]
} }