1SIEVEC(1) Pigeonhole SIEVEC(1)
2
6 sievec - Pigeonhole's Sieve script compiler
7
9 sievec [options] script-file [out-file]
10
12 The sievec command is part of the Pigeonhole Project (pigeonhole(7)),
13 which adds Sieve (RFC 5228) support to the Dovecot secure IMAP and POP3
14 server (dovecot(1)).
15 Using the sievec command, Sieve scripts can be compiled into a binary
17 representation. The resulting binary can be used directly to process
18 e-mail messages during the delivery process. The delivery of mail mes‐
19 sages and - by means of the LDA Sieve plugin - also the execution of
20 Sieve scripts is performed by Dovecot's local delivery agent (LDA)
21 called dovecot-lda(1). Usually, it is not necessary to compile the
22 Sieve script manually using sievec, because dovecot-lda will do this
23 automatically if the binary is missing. However, in some cases dove‐
24 cot-lda does not have permission to write the compiled binary to disk,
25 forcing it to recompile the script every time it is executed. Using the
26 sievec tool, this can be performed manually by an authorized user to
27 increase performance.
28 The Pigeonhole Sieve implementation recognizes files with a .sieve
30 extension as Sieve scripts and corresponding files with a .svbin exten‐
31 sion as the associated compiled binary. This means for example that
32 Dovecot's LDA process will first look for a binary file "dovecot.svbin"
33 when it needs to execute "dovecot.sieve". It will compile a new binary
34 when it is missing or outdated.
35 The sievec command is also useful to verify Sieve scripts before using.
37 Additionally, with the -d option it can output a textual (and thus
38 human-readable) dump of the generated Sieve code to the specified file.
39 The output is then identical to what the sieve-dump(1) command produces
40 for a stored binary file. This output is mainly useful to find bugs in
41 the compiler that yield corrupt binaries.
42
44 -c config-file
45 Alternative Dovecot configuration file path.
46 -d Don't write the binary to out-file, but write a textual dump of
48 the binary instead. In this context, the out-file value '-' has
49 special meaning: it causes the the textual dump to be written to
50 stdout. The out-file argument may also be omitted, which has
51 the same effect as '-'. The output is identical to what the
52 sieve-dump(1) command produces for a compiled Sieve binary file.
53 Note that this option is not allowed when the out-file argument
54 is a directory.
55 -D Enable Sieve debugging.
57 -o setting=value
59 Overrides the configuration setting from /etc/dovecot/dove‐
60 cot.conf and from the userdb with the given value. In order to
61 override multiple settings, the -o option may be specified mul‐
62 tiple times.
63 -u user
65 Run the Sieve script for the given user. When omitted, the com‐
66 mand will be executed with the environment of the currently
67 logged in user.
68 -x extensions
70 Set the available extensions. The parameter is a space-separated
71 list of the active extensions. By prepending the extension iden‐
72 tifiers with + or -, extensions can be included or excluded rel‐
73 ative to the configured set of active extensions. If no exten‐
74 sions have a + or - prefix, only those extensions that are
75 explicitly listed will be enabled. Unknown extensions are
76 ignored and a warning is produced.
77 For example -x "+imapflags -enotify" will enable the deprecated
79 imapflags extension and disable the enotify extension. The rest
80 of the active extensions depends on the sieve_extensions and
81 sieve_global_extensions settings. By default, i.e. when
82 sieve_extensions and sieve_global_extensions remain unconfig‐
83 ured, all supported extensions are available, except for depre‐
84 cated extensions or those that are still under development.
85
88 script-file
89 Specifies the script to be compiled. If the script-file argument
90 is a directory, all files in that directory with a .sieve exten‐
91 sion are compiled into a corresponding .svbin binary file. The
92 compilation is not halted upon errors; it attempts to compile as
93 many scripts in the directory as possible. Note that the -d
94 option and the out-file argument are not allowed when the
95 script-file argument is a directory.
96 out-file
98 Specifies where the (binary) output is to be written. This argu‐
99 ment is optional. If this argument is omitted, a binary com‐
100 piled from <scriptname>.sieve is saved as <scriptname>.svbin. If
101 this argument is omitted and -b is specified, the binary dump is
102 output to stdout.
103
105 sievec will exit with one of the following values:
106 0 Compile was successful. (EX_OK, EXIT_SUCCESS)
108 1 Operation failed. This is returned for almost all failures.
110 (EXIT_FAILURE)
111 64 Invalid parameter given. (EX_USAGE)
113
115 /etc/dovecot/dovecot.conf
116 Dovecot's main configuration file.
117 /etc/dovecot/conf.d/90-sieve.conf
119 Sieve interpreter settings (included from Dovecot's main config‐
120 uration file)
121
123 Report bugs, including doveconf -n output, to the Dovecot Mailing List
124 <dovecot@dovecot.org>. Information about reporting bugs is available
125 at: http://dovecot.org/bugreport.html
126
128 dovecot(1), dovecot-lda(1), sieve-dump(1), sieve-filter(1),
129 sieve-test(1), pigeonhole(7)
130Pigeonhole v0.5 for Dovecot v2.3 2017-12-18 SIEVEC(1)