1SIEVE-DUMP(1) Pigeonhole SIEVE-DUMP(1)
2
6 sieve-dump - Pigeonhole's Sieve script binary dump tool
7
9 sieve-dump [options] sieve-binary [out-file]
10
12 The sieve-dump command is part of the Pigeonhole Project (pigeon‐
13 hole(7)), which adds Sieve (RFC 5228) support to the Dovecot secure
14 IMAP and POP3 server (dovecot(1)).
15 Using the sieve-dump command, Sieve binaries, which are produced for
17 instance by sievec(1), can be transformed into a human-readable textual
18 representation. This can provide valuable insight in how the Sieve
19 script is executed. This is also particularly useful to view corrupt
20 binaries that can result from bugs in the Sieve implementation. This
21 tool is intended mainly for development purposes, so normally system
22 administrators and users will not need to use this tool.
23 The format of the output is not explained here in detail, but it should
25 be relatively easy to understand. The Sieve binaries comprise a set of
26 data blocks, each of which can contain arbitrary data. For the base
27 language implementation two blocks are used: the first containing a
28 specification of all required language extensions and the second con‐
29 taining the main Sieve program. Compiled Sieve programs are represented
30 as flat byte code and therefore the dump of the main program is a dis‐
31 assembly listing of the interpreter operations. Extensions can define
32 new operations and use additional blocks. Therefore, the output of
33 sieve-dump depends greatly on the language extensions used when compil‐
34 ing the binary.
35
37 -c config-file
38 Alternative Dovecot configuration file path.
39 -D Enable Sieve debugging.
41 -h Produce per-block hexdump output of the whole binary instead of
43 the normal human-readable output.
44 -o setting=value
46 Overrides the configuration setting from /etc/dovecot/dove‐
47 cot.conf and from the userdb with the given value. In order to
48 override multiple settings, the -o option may be specified mul‐
49 tiple times.
50 -u user
52 Run the Sieve script for the given user. When omitted, the com‐
53 mand will be executed with the environment of the currently
54 logged in user.
55 -x extensions
57 Set the available extensions. The parameter is a space-separated
58 list of the active extensions. By prepending the extension iden‐
59 tifiers with + or -, extensions can be included or excluded rel‐
60 ative to the configured set of active extensions. If no exten‐
61 sions have a + or - prefix, only those extensions that are
62 explicitly listed will be enabled. Unknown extensions are
63 ignored and a warning is produced.
64 For example -x "+imapflags -enotify" will enable the deprecated
66 imapflags extension and disable the enotify extension. The rest
67 of the active extensions depends on the sieve_extensions and
68 sieve_global_extensions settings. By default, i.e. when
69 sieve_extensions and sieve_global_extensions remain unconfig‐
70 ured, all supported extensions are available, except for depre‐
71 cated extensions or those that are still under development.
72
75 sieve-binary
76 Specifies the Sieve binary file that needs to be dumped.
77 out-file
79 Specifies where the output must be written. This argument is
80 optional. If omitted, the output is written to stdout.
81
83 sieve-dump will exit with one of the following values:
84 0 Dump was successful. (EX_OK, EXIT_SUCCESS)
86 1 Operation failed. This is returned for almost all failures.
88 (EXIT_FAILURE)
89 64 Invalid parameter given. (EX_USAGE)
91
93 /etc/dovecot/dovecot.conf
94 Dovecot's main configuration file.
95 /etc/dovecot/conf.d/90-sieve.conf
97 Sieve interpreter settings (included from Dovecot's main config‐
98 uration file)
99
101 Report bugs, including doveconf -n output, to the Dovecot Mailing List
102 <dovecot@dovecot.org>. Information about reporting bugs is available
103 at: http://dovecot.org/bugreport.html
104
106 dovecot(1), dovecot-lda(1), sieve-filter(1), sieve-test(1), sievec(1),
107 pigeonhole(7)
108Pigeonhole for Dovecot v2.4 2016-04-05 SIEVE-DUMP(1)