Skip to content
Snippets Groups Projects
Commit 7527d467 authored by Stephan Bosch's avatar Stephan Bosch
Browse files

Updated README file.

parent 8687fe89
No related branches found
No related tags found
No related merge requests found
...@@ -95,7 +95,7 @@ following list outlines the implementation status of each supported extension: ...@@ -95,7 +95,7 @@ following list outlines the implementation status of each supported extension:
vacation: mostly full; handling of utf-8 in headers is non-existant vacation: mostly full; handling of utf-8 in headers is non-existant
imapflags: full imapflags: full
variables: mostly full; currently no support for future namespaces variables: mostly full; currently no support for future namespaces
notify: almost complete, mailto support only notify: full, mailto support only; needs to be tested more
All implemented extensions are like the engine itself currently experimental. All implemented extensions are like the engine itself currently experimental.
A status of 'full' does not necessarily mean that the extension is bug-free or A status of 'full' does not necessarily mean that the extension is bug-free or
...@@ -111,8 +111,7 @@ has taken notice of the following extensions: ...@@ -111,8 +111,7 @@ has taken notice of the following extensions:
mimeloop: planned mimeloop: planned
These extensions will be added as soon as the necessary infrastructure is These extensions will be added as soon as the necessary infrastructure is
available. Extensions already supported by cmusieve have priority, meaning that available.
notify is next in line.
Compiling and Configuring Compiling and Configuring
------------------------- -------------------------
...@@ -124,14 +123,14 @@ Using ...@@ -124,14 +123,14 @@ Using
The main purpose of this package is to replace the existing cmusieve plugin that The main purpose of this package is to replace the existing cmusieve plugin that
is currently available for Dovecot's deliver. With this respect it is currently is currently available for Dovecot's deliver. With this respect it is currently
not very different from the cmusieve plugin implementation. not very different from the cmusieve plugin implementation.
Unlike cmusieve, this sieve module logs runtime errors to <scriptfile>.log if Unlike cmusieve, this sieve module logs runtime errors to <scriptfile>.log if
it can and not <scriptfile>.err. It appends new timestamped log entries to the it can and not <scriptfile>.err. It appends new timestamped log entries to the
end of the logfile. If the log grows too large (currently > 10kB), the logfile end of the logfile. If the log grows too large (currently > 10kB), the logfile
is rotated to <scriptfile>.log.0 and <scriptfile>.log starts out empty again. is rotated to <scriptfile>.log.0 and <scriptfile>.log starts out empty again.
The cmusieve plugin compiled the script into a file with an appended c, e.g. The cmusieve plugin compiled the script into a file with an appended 'c', e.g.
'test.sievec'. This new implementation recognizes scripts to have the .sieve 'test.sievec'. This new implementation recognizes scripts to have the .sieve
extension. The binary is (by default) written to a file with extension .svbin. extension. The binary is (by default) written to a file with extension .svbin.
This means that the default .dovecot.sieve is compiled into .dovecot.svbin. This means that the default .dovecot.sieve is compiled into .dovecot.svbin.
...@@ -147,16 +146,16 @@ installed: ...@@ -147,16 +146,16 @@ installed:
sievec - Compiles sieve scripts into a binary representation for later sievec - Compiles sieve scripts into a binary representation for later
execution. execution.
sieved - Dumps the content of a Sieve binary file for (development)
debugging purposes.
sieve-test - This is a universal Sieve test tool for testing the effect of a sieve-test - This is a universal Sieve test tool for testing the effect of a
Sieve script on a particular message.. It allows compiling, running Sieve script on a particular message. It allows compiling, running
and testing Sieve scripts. It can either be used to display the and testing Sieve scripts. It can either be used to display the
actions that would be performed on the provided test message or it actions that would be performed on the provided test message or it
can be used to test the actual delivery of one message and show the can be used to test the actual delivery of the message and show the
messages that would normally be sent through SMTP. messages that would normally be sent through SMTP.
sieved - Dumps the content of a Sieve binary file for (development)
debugging purposes.
When installed, man pages are also available for these commands. In this package When installed, man pages are also available for these commands. In this package
the man pages are present in doc/man and can be viewed before install using e.g.: the man pages are present in doc/man and can be viewed before install using e.g.:
...@@ -175,7 +174,7 @@ listed here: ...@@ -175,7 +174,7 @@ listed here:
- Compile errors are sometimes a bit obscure and long. This needs work. - Compile errors are sometimes a bit obscure and long. This needs work.
Suggestions for improvement are welcome. Suggestions for improvement are welcome.
- The documentation needs work. The wiki needs to be updated with the newly - The documentation needs work. The wiki needs to be updated with the newly
supported extensions. supported features and extensions.
Authors Authors
------- -------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.