.\" Copyright (c) 2010-2017 Pigeonhole authors, see the included COPYING file
.TH DOVEADM\-SIEVE 1 "2016-02-29" "Pigeonhole v0.4 for Dovecot v2.2" "Pigeonhole"
.SH NAME
doveadm\-sieve \- Commands related to handling Sieve scripts
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.BR doveadm " [" \-Dv "] [" \-f
.IR formatter "] " sieve_cmd " [" options "] [" arguments ]
.\"------------------------------------------------------------------------
.SH DESCRIPTION
.PP
The
.B doveadm sieve
commands are part of the Pigeonhole Project (\fBpigeonhole\fR(7)), which adds
Sieve (RFC 5228) and ManageSieve (RFC 5804) support to the Dovecot secure IMAP
and POP3 server (\fBdovecot\fR(1)). The
.B doveadm sieve
commands can be used to manage Sieve filtering.
.\"------------------------------------------------------------------------
.SH OPTIONS
Global
.BR doveadm (1)
.IR options :
.TP
.B \-D
Enables verbosity and debug messages.
.TP
.BI \-f\  formatter
Specifies the
.I formatter
for formatting the output.
Supported formatters are:
.RS
.TP
.B flow
prints each line with
.IB key = value
pairs.
.TP
.B pager
prints each
.IR key :\  value
pair on its own line and separates records with form feed character
.RB ( ^L ).
.TP
.B tab
prints a table header followed by tab separated value lines.
.TP
.B table
prints a table header followed by adjusted value lines.
.RE
.TP
.BI \-o\  setting = value
Overrides the configuration
.I setting
from
.I /etc/dovecot/dovecot.conf
and from the userdb with the given
.IR value .
In order to override multiple settings, the
.B \-o
option may be specified multiple times.
.TP
.B \-v
Enables verbosity, including progress counter.
.\" --- command specific options --- "/.
.PP
Command specific
.IR options :
.\"-------------------------------------
.TP
.B \-A
If the
.B \-A
option is present, the
.I command
will be performed for all users.
Using this option in combination with system users from
.B userdb { driver = passwd }
is not recommended, because it contains also users with a lower UID than
the one configured with the
.I first_valid_uid
setting.
.sp
When the SQL userdb module is used make sure that the
.I iterate_query
setting in
.I /etc/dovecot/dovecot\-sql.conf.ext
matches your database layout.
When using the LDAP userdb module, make sure that the
.IR iterate_attrs " and " iterate_filter
settings in
.I /etc/dovecot/dovecot-ldap.conf.ext
match your LDAP schema.
Otherwise
.BR doveadm (1)
will be unable to iterate over all users.
.\"-------------------------------------
.TP
.BI \-S\  socket_path
The option\(aqs argument is either an absolute path to a local UNIX domain
socket, or a hostname and port
.RI ( hostname : port ),
in order to connect a remote host via a TCP socket.
.sp
This allows an administrator to execute
.BR doveadm (1)
mail commands through the given socket.
.\"-------------------------------------
.TP
.BI \-u\  user/mask
Run the
.I command
only for the given
.IR user .
It\(aqs also possible to use
.RB \(aq * \(aq
and
.RB \(aq ? \(aq
wildcards (e.g. \-u *@example.org).
.br
When neither the
.B \-A
option nor
.BI \-u\  user
was specified, the
.I command
will be executed with the environment of the
currently logged in user.
.\"------------------------------------------------------------------------
.SH ARGUMENTS
.TP
.I scriptname
Is the name of a
.IR Sieve\ script ,
as visible to ManageSieve clients.
.IP
NOTE: For Sieve scripts that are stored on disk, this is the filename without the
".sieve" extension.
.\"------------------------------------------------------------------------
.SH COMMANDS
.SS sieve put
.B doveadm sieve put
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.RB [ \-a ]
.IR scriptname
.PP
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 
.IR scriptname\ . 
If the
.B \-a
option is present, the Sieve script is subsequently marked as the active script
for execution at delivery.
.\"------------------------------------------------------------------------
.SS sieve get
.B doveadm sieve get
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I scriptname
.PP
This command retrieves the Sieve script named
.IR scriptname .
.\"------------------------------------------------------------------------
.SS sieve delete
.B doveadm sieve delete
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.RB [ \-a ]
.IR scriptname\  ...
.PP
This command deletes one or more Sieve scripts. The deleted script may not be the
active script, unless the 
.B \-a
option is present.
.\"------------------------------------------------------------------------
.SS sieve list
.B doveadm sieve list
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I scriptname
.PP
Use this command to get an overview of existing Sieve scripts.
.\"------------------------------------------------------------------------
.SS sieve rename
.B doveadm sieve rename
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I old_name
.I new_name
.PP
The
.B sieve rename
command is used to rename the Sieve script
.I old_name
to
.IR new_name .
.\"------------------------------------------------------------------------
.SS sieve activate
.B doveadm sieve activate
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.IR scriptname
.PP
This command marks the Sieve script named 
.I scriptname
as the active script for execution at delivery.
.\"------------------------------------------------------------------------
.SS sieve deactivate
.B doveadm sieve deactivate
[\fB\-A\fP|\fB\-u\fP \fIuser\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I scriptname
.PP
This command deactivates Sieve processing.
.\"------------------------------------------------------------------------
.SH REPORTING BUGS
Report bugs, including
.I doveconf \-n
output, to the Dovecot Mailing List <dovecot@dovecot.org>.
Information about reporting bugs is available at:
http://dovecot.org/bugreport.html
.\"------------------------------------------------------------------------
.SH SEE ALSO
.BR doveadm (1)
.BR dovecot\-lda (1),
.BR pigeonhole (7)