1DOVEADM-SIEVE(1) Pigeonhole DOVEADM-SIEVE(1)
2
3
4
6 doveadm-sieve - Commands related to handling Sieve scripts
7
9 doveadm [-Dv] [-f formatter] sieve_cmd [options] [arguments]
10
12 The doveadm sieve commands are part of the Pigeonhole Project (pigeon‐
13 hole(7)), which adds Sieve (RFC 5228) and ManageSieve (RFC 5804) sup‐
14 port to the Dovecot secure IMAP and POP3 server (dovecot(1)). The
15 doveadm sieve commands can be used to manage Sieve filtering.
16
18 Global doveadm(1) options:
19
20 -D Enables verbosity and debug messages.
21
22 -f formatter
23 Specifies the formatter for formatting the output. Supported
24 formatters are:
25
26 flow prints each line with key=value pairs.
27
28 pager prints each key: value pair on its own line and separates
29 records with form feed character (^L).
30
31 tab prints a table header followed by tab separated value
32 lines.
33
34 table prints a table header followed by adjusted value lines.
35
36 -o setting=value
37 Overrides the configuration setting from /etc/dovecot/dove‐
38 cot.conf and from the userdb with the given value. In order to
39 override multiple settings, the -o option may be specified mul‐
40 tiple times.
41
42 -v Enables verbosity, including progress counter.
43
44 Command specific options:
45
46 -A If the -A option is present, the command will be performed for
47 all users. Using this option in combination with system users
48 from userdb { driver = passwd } is not recommended, because it
49 contains also users with a lower UID than the one configured
50 with the first_valid_uid setting.
51
52 When the SQL userdb module is used make sure that the iter‐
53 ate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches
54 your database layout. When using the LDAP userdb module, make
55 sure that the iterate_attrs and iterate_filter settings in
56 /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. Oth‐
57 erwise doveadm(1) will be unable to iterate over all users.
58
59 -S socket_path
60 The option's argument is either an absolute path to a local UNIX
61 domain socket, or a hostname and port (hostname:port), in order
62 to connect a remote host via a TCP socket.
63
64 This allows an administrator to execute doveadm(1) mail commands
65 through the given socket.
66
67 -u user/mask
68 Run the command only for the given user. It's also possible to
69 use '*' and '?' wildcards (e.g. -u *@example.org).
70 When neither the -A option nor -u user was specified, the com‐
71 mand will be executed with the environment of the currently
72 logged in user.
73
75 scriptname
76 Is the name of a Sieve script, as visible to ManageSieve
77 clients.
78
79 NOTE: For Sieve scripts that are stored on disk, this is the
80 filename without the ".sieve" extension.
81
83 sieve put
84 doveadm sieve put [-A|-u user] [-S socket_path] [-a] scriptname
85
86 This command puts one new Sieve script in the script storage. The
87 script is read from standard input. If the script compiles success‐
88 fully, it is stored under the provided scriptname . If the -a option
89 is present, the Sieve script is subsequently marked as the active
90 script for execution at delivery.
91
92 sieve get
93 doveadm sieve get [-A|-u user] [-S socket_path] scriptname
94
95 This command retrieves the Sieve script named scriptname.
96
97 sieve delete
98 doveadm sieve delete [-A|-u user] [-S socket_path] [-a] scriptname ...
99
100 This command deletes one or more Sieve scripts. The deleted script may
101 not be the active script, unless the -a option is present.
102
103 sieve list
104 doveadm sieve list [-A|-u user] [-S socket_path] scriptname
105
106 Use this command to get an overview of existing Sieve scripts.
107
108 sieve rename
109 doveadm sieve rename [-A|-u user] [-S socket_path] old_name new_name
110
111 The sieve rename command is used to rename the Sieve script old_name to
112 new_name.
113
114 sieve activate
115 doveadm sieve activate [-A|-u user] [-S socket_path] scriptname
116
117 This command marks the Sieve script named scriptname as the active
118 script for execution at delivery.
119
120 sieve deactivate
121 doveadm sieve deactivate [-A|-u user] [-S socket_path] scriptname
122
123 This command deactivates Sieve processing.
124
126 Report bugs, including doveconf -n output, to the Dovecot Mailing List
127 <dovecot@dovecot.org>. Information about reporting bugs is available
128 at: http://dovecot.org/bugreport.html
129
131 doveadm(1) dovecot-lda(1), pigeonhole(7)
132
133
134
135Pigeonhole for Dovecot v2.4 2016-02-29 DOVEADM-SIEVE(1)