.TH "SIEVE-DUMP" "1" "October 2025" "65dfbff" "Dovecot"
.SH "NAME"
\fBsieve-dump\fR - Pigeonhole's Sieve script binary dump tool
.SH "SYNOPSIS"
.P
\fBsieve-dump\fR \[lB]\fIoptions\fR\[rB] \fIsieve-binary\fR \[lB]\fIout-file\fR\[rB]
.SH "DESCRIPTION"
.P
 command is part of Pigeonhole (pigeonhole(7)), which adds Sieve (RFC 5228) and ManageSieve (RFC 5804) support to Dovecot (dovecot(1)).
.P
 command, Sieve binaries, which are produced for instance by sievec(1), can be transformed into a human-readable textual representation. This can provide valuable insight in how the Sieve script is executed. This is also particularly useful to view corrupt binaries that can result from bugs in the Sieve implementation. This tool is intended mainly for development purposes, so normally system administrators and users will not need to use this tool.
.P
The format of the output is not explained here in detail, but it should be relatively easy to understand. The Sieve binaries comprise a set of data blocks, each of which can contain arbitrary data. For the base language implementation two blocks are used: the first containing a specification of all required language extensions and the second containing the main Sieve program. Compiled Sieve programs are represented as flat byte code and therefore the dump of the main program is a disassembly listing of the interpreter operations. Extensions can define new operations and use additional blocks. Therefore, the output of \fBsieve-dump\fR depends greatly on the language extensions used when compiling the binary.
.SH "OPTIONS"
.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Alternative Dovecot configuration file path.
.RE 0

.RE 0

.P
\fB-D\fR
.RS 0
.RS 4
.P
Enable Sieve debugging.
.RE 0

.RE 0

.P
\fB-h\fR
.RS 0
.RS 4
.P
Produce per-block hexdump output of the whole binary instead of the normal human-readable output.
.RE 0

.RE 0

.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0

.RE 0

.P
\fB-u\fR \fIuser/mask\fR
.RS 0
.RS 4
.P
Run the \fIcommand\fR only for the given \fIuser\fR. It's also possible to use '\fB*\fR' and '\fB?\fR' wildcards (e.g. -u *@example.org).
.RE 0

.RE 0

.P
\fB-x\fR \fIauth_info\fR
.RS 0
.RS 4
.P
\fIauth_info\fR specifies additional conditions for the \fBuser\fR command. The \fIauth_info\fR option string has to be given as \fIname\fR \fB=\fR \fIvalue\fR pair. For multiple conditions the \fB-x\fR option could be supplied multiple times.
.P
Possible names for the \fIauth_info\fR are:
.P
\fBservice\fR
.RS 4
.P
The service for which the userdb lookup should be tested. The value may be the name of a service, commonly used with Dovecot. For example: \fBimap\fR, \fBpop3\fR or \fBsmtp\fR.
.RE 0

.P
\fBsession\fR
.RS 4
.P
Session identifier.
.RE 0

.P
\fBlip\fR
.RS 4
.P
The local IP address (server) for the test.
.RE 0

.P
\fBrip\fR
.RS 4
.P
The remote IP address (client) for the test.
.RE 0

.P
\fBlport\fR
.RS 4
.P
The local port, e.g. 143
.RE 0

.P
\fBrport\fR
.RS 4
.P
The remote port, e.g. 24567
.RE 0

.P
\fBreal_lip\fR
.RS 4
.P
The local IP to which the client connected on this host.
.RE 0

.P
\fBreal_rip\fR
.RS 4
.P
The remote IP where client connected from to this host.
.RE 0

.P
\fBreal_lport\fR
.RS 4
.P
The local port to which client connected to to this host.
.RE 0

.P
\fBreal_rport\fR
.RS 4
.P
The remote port from where the client connected from to this host.
.RE 0

.P
\fBforward_<field>\fR
.RS 4
.P
Field to forward as %{forward:field} to auth process.
.RE 0

.RE 0

.RE 0

.SH "ARGUMENTS"
.P
\fIsieve-binary\fR
.RS 0
.RS 4
.P
Specifies the Sieve binary file that needs to be dumped.
.RE 0

.RE 0

.P
\fIout-file\fR
.RS 0
.RS 4
.P
Specifies where the output must be written. This argument is optional. If omitted, the output is written to \fBstdout\fR.
.RE 0

.RE 0

.SH "EXIT STATUS"
.P
\fBsieve-dump\fR will exit with one of the following values:
.P
\fB0\fR
.RS 0
.RS 4
.P
Dump was successful. (EX_OK, EXIT_SUCCESS)
.RE 0

.RE 0

.P
\fB1\fR
.RS 0
.RS 4
.P
Operation failed. This is returned for almost all failures. (EXIT_FAILURE)
.RE 0

.RE 0

.P
\fB64\fR
.RS 0
.RS 4
.P
Invalid parameter given. (EX_USAGE)
.RE 0

.RE 0

.SH "FILES"
.P
\fI/etc/dovecot/dovecot.conf\fR
.RS 0
.RS 4
.P
Dovecot's main configuration file.
.RE 0

.RE 0

.P
\fI/etc/dovecot/conf.d/90-sieve.conf\fR
.RS 0
.RS 4
.P
Sieve interpreter settings (included from Dovecot's main
.RE 0

.RE 0

.RS 0
.RS 4
.P
configuration file)
.RE 0

.RE 0

.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
dovecot(1), dovecot-lda(1), sieve-filter(1), sieve-test(1), sievec(1), pigeonhole(7)