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

Documented vnd.dovecot.debug in the sieve-test man page.

parent 67e76294
No related branches found
No related tags found
No related merge requests found
...@@ -89,6 +89,28 @@ Enable simple trace debugging; prints all encountered byte code instructions to ...@@ -89,6 +89,28 @@ Enable simple trace debugging; prints all encountered byte code instructions to
\fB-x\fP "\fIextension extension ...\fP" \fB-x\fP "\fIextension extension ...\fP"
Set the available extensions. The option's parameter is a space-separated list of the active Set the available extensions. The option's parameter is a space-separated list of the active
extensions. Unknown extensions are ignored, but a warning is produced. extensions. Unknown extensions are ignored, but a warning is produced.
.SH DEBUG SUPPORT
.PP
To improve script debugging, the Sieve command line tools such as \fBsieve-test\fP support a custom
Sieve language extension called 'vnd.dovecot.debug'. It adds the \fBdebug_print\fP command that allows
printing debug messages to \fBstdout\fP.
.PP
Example:
.PP
require "vnd.dovecot.debug";
.PP
if header :contains "subject" "hello" {
.PP
debug_print "Subject header contains hello!";
.PP
}
.PP
Other tools like \fBsievec\fP and \fBsieved\fP also recognize the vnd.dovecot.debug extension. In contrast,
the actual Sieve plugin for Deliver does not allow the use of the debug extension. So, keep in mind that
scripts and compiled binaries that refer to de debug extension will fail to be run by the Sieve plugin itself.
.PP
Note that it is not necessary to enable nor possible to disable the availability of the debug extension with
the \fB-x\fP option.
.SH AUTHOR .SH AUTHOR
.PP .PP
The Sieve implementation for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>. The Sieve implementation for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>.
......
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.