.TH "DOVEADM-SIEVE" "1" "October 2025" "65dfbff" "Dovecot"
.SH "NAME"
\fBdoveadm-sieve\fR - Commands related to handling Sieve scripts
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fIsieve_cmd\fR \[lB]\fIoptions\fR\[rB] \[lB]\fIarguments\fR\[rB]
.SH "DESCRIPTION"
.P
 commands are part of Pigeonhole (pigeonhole(7)), which adds Sieve (RFC 5228) and ManageSieve (RFC 5804) support to Dovecot (dovecot(1)).
.P
The \fBdoveadm sieve\fR commands can be used to manage Sieve filtering.
.SH "GLOBAL OPTIONS"
.P
Global doveadm(1) 
.P
\fB-D\fR
.RS 0
.RS 4
.P
Enables \fIverbosity\fR and debug messages.
.RE 0

.RE 0

.P
\fB-O\fR
.RS 0
.RS 4
.P
Do not read any config file, just use defaults. The \fBdovecot_storage_version\fR setting defaults to the latest version, but can be overridden with 
.RE 0

.RE 0

.P
\fB-k\fR
.RS 0
.RS 4
.P
Preserve entire environment for doveadm, not just \fBimport_environment\fR setting.
.RE 0

.RE 0

.P
\fB-v\fR
.RS 0
.RS 4
.P
Enables verbosity, including progress counter.
.RE 0

.RE 0

.P
\fB-i\fR \fIinstance-name\fR
.RS 0
.RS 4
.P
If using multiple Dovecot instances, choose the config file based on this instance name.
.P
See \fBinstance_name\fR setting for more information.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Read configuration from the given \fIconfig-file\fR. By default it first reads config socket, and then falls back to \fI/etc/dovecot/dovecot.conf\fR. You can also point this to config socket of some instance running compatible version.
.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-f\fR \fIformatter\fR
.RS 0
.RS 4
.P
Specifies the \fIformatter\fR for formatting the output. Supported formatters are:
.P
\fBflow\fR
.RS 4
.P
prints each line with \fIkey\fR\fB=\fR\fIvalue\fR pairs.
.RE 0

.P
\fBjson\fR
.RS 4
.P
prints a JSON array of JSON objects.
.RE 0

.P
\fBpager\fR
.RS 4
.P
prints each \fIkey\fR: \fIvalue\fR pair on its own line and separates records with form feed character (\fB^L\fR).
.RE 0

.P
\fBtab\fR
.RS 4
.P
prints a table header followed by tab separated value lines.
.RE 0

.P
\fBtable\fR
.RS 4
.P
prints a table header followed by adjusted value lines.
.RE 0

.RE 0

.RE 0

.SH "OPTIONS"
.P
\fB-A\fR
.RS 0
.RS 4
.P
If the \fB-A\fR option is present, the \fIcommand\fR will be performed for all users. Using this option in combination with system users from \fBuserdb { driver = passwd }\fR is not recommended, because it contains also users with a lower UID than the one configured with the \fBfirst_valid_uid\fR setting.
.P
When the SQL userdb module is used, make sure that the \fBuserdb_sql_iterate_query\fR setting setting matches your database layout.
.P
When using the LDAP userdb module, make sure that the \fBuserdb_fields\fR setting and \fBuserdb_ldap_iterate_fields\fR setting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
.RE 0

.RE 0

.P
\fB-F\fR \fIfile\fR
.RS 0
.RS 4
.P
Execute the \fIcommand\fR for all the users in the \fIfile\fR. This is similar to the \fB-A\fR option, but instead of getting the list of users from the userdb, they are read from the given \fIfile\fR. The \fIfile\fR contains one username per line.
.RE 0

.RE 0

.P
\fB--no-userdb-lookup\fR
.RS 0
.RS 4
.P
Do not perform userdb lookup. Use the \fBUSER\fR environment variable to specify the username.
.RE 0

.RE 0

.P
\fB-S\fR \fIsocket_path\fR
.RS 0
.RS 4
.P
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (\fIhostname\fR:\fIport\fR), in order to connect a remote host via a TCP socket.
.P
This allows an administrator to execute doveadm(1) mail commands through the given socket.
.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

.SH "ARGUMENTS"
.P
\fIscriptname\fR
.RS 0
.RS 4
.P
Is the name of a \fISieve script\fR, as visible to ManageSieve clients.
.P
For Sieve scripts that are stored on disk, this is the filename without the ".sieve" extension.
.RE 0

.RE 0

.SH "COMMANDS"
.SS "sieve put"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve put \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-a\fR\[rB] \fIscriptname\fR
.P
This command puts one new Sieve script in the script storage. The script is read from standard input. If the script compiles successfully, it is stored under the provided \fIscriptname .\fR If the \fB-a\fR option is present, the Sieve script is subsequently marked as the active script for execution at delivery.
.SS "sieve get"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve get \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIscriptname\fR
.P
This command retrieves the Sieve script named \fIscriptname\fR.
.SS "sieve delete"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve delete \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-a\fR\[rB] \fIscriptname\fR ...
.P
This command deletes one or more Sieve scripts. The deleted script may not be the active script, unless the \fB-a\fR option is present.
.SS "sieve list"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve list \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB]
.P
List existing Sieve scripts, and their active state.
.SS "sieve rename"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve rename \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIold_name\fR \fInew_name\fR
.P
The \fBsieve rename\fR command is used to rename the Sieve script \fIold_name\fR to \fInew_name\fR.
.SS "sieve activate"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve activate \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIscriptname\fR
.P
This command marks the Sieve script named \fIscriptname\fR as the active script for execution at delivery.
.SS "sieve deactivate"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] sieve deactivate \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIscriptname\fR
.P
This command deactivates Sieve processing.
.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
doveadm(1), dovecot-lda(1), pigeonhole(7)