sievec(1)

1SIEVEC(1)                         Pigeonhole                         SIEVEC(1)
2
3
4

NAME

6       sievec - Pigeonhole's Sieve script compiler
7

SYNOPSIS

9       sievec [options] script-file [out-file]
10

DESCRIPTION

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
16       Using  the  sievec command, Sieve scripts can be compiled into a binary
17       representation. The resulting binary can be used  directly  to  process
18       e-mail  messages during the delivery process. The delivery of mail mes‐
19       sages and - by means of the LDA Sieve plugin - also  the  execution  of
20       Sieve  scripts  is  performed  by  Dovecotqs local delivery agent (LDA)
21       called dovecot-lda(1).  Usually, it  is  not  necessaryto  compile  the
22       Sieve  script  manually  using sievec, because dovecot-lda will do this
23       automatically if the binary is missing. However, in  some  cases  dove‐
24       cot-lda  does not have permission to write the compiled binary to disk,
25       forcing it to recompile the script every time it is executed. Using the
26       sievec  tool,  this  can be performed manually by an authorized user to
27       increase performance.
28
29       The Pigeonhole Sieve implementation  recognizes  files  with  a  .sieve
30       extension as Sieve scripts and corresponding files with a .svbin exten‐
31       sion as the associated compiled binary. This  means  for  example  that
32       Dovecot's LDA process will first look for a binary file "dovecot.svbin"
33       when it needs to execute "dovecot.sieve". It will compile a new  binary
34       when it is missing.
35
36       The sievec command is also useful to verify Sieve scripts before using.
37       Additionally, with the -d option it can  output  a  textual  (and  thus
38       human-readable) dump of the generated Sieve code to the specified file.
39       The output is then identical to what the sieve-dump(1) command produces
40       for  a stored binary file. This output is mainly useful to find bugs in
41       the compiler that yield corrupt binaries.
42

OPTIONS

44       -c config-file
45              Alternative Dovecot configuration file path.
46
47       -d     Don't write the binary to out-file, but write a textual dump  of
48              the  binary instead. In this context, the out-file value '-' has
49              special meaning: it causes the the textual dump to be written to
50              stdout.   The  out-file  argument may also be omitted, which has
51              the same effect as '-'.  The output is  identical  to  what  the
52              sieve-dump(1) command produces for a compiled Sieve binary file.
53              Note that this option is not allowed when the out-file  argument
54              is a directory.
55
56       -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 default set of extensions. If no extensions have  a
61              +  or - prefix, only those extensions that are explicitly listed
62              will be enabled. Unknown extensions are ignored and a warning is
63              produced.  By  default,  all supported extensions are available,
64              except for deprecated extensions or those that are  still  under
65              development.
66
67              For  example -x "+imapflags -enotify" will enable the deprecated
68              imapflags extension along with all extensions that are available
69              by default, except for the enotify extension.
70

ARGUMENTS

72       script-file
73              Specifies the script to be compiled. If the script-file argument
74              is a directory, all files in that directory with a .sieve exten‐
75              sion  are  compiled into a corresponding .svbin binary file. The
76              compilation is not halted upon errors; it attempts to compile as
77              many  scripts  in  the  directory  as possible. Note that the -d
78              option and the  out-file  argument  are  not  allowed  when  the
79              script-file argument is a directory.
80
81       out-file
82              Specifies where the (binary) output is to be written. This argu‐
83              ment is optional.  If omitted a binary  compiled  from  <script‐
84              name>.sieve  is saved as <scriptname>.svbin. If -b is specified,
85              the binary dump is output to stdout.
86

EXIT STATUS

88       sievec will exit with one of the following values:
89
90       0   Delivery was successful. (EX_OK, EXIT_SUCCES)
91
92       1   Operation  failed.  This  is  returned  for  almost  all  failures.
93           (EXIT_FAILURE)
94
95       64  Invalid parameter given. (EX_USAGE)
96

FILES

98       /usr/local/etc/dovecot/dovecot.conf
99              Dovecot's main configuration file.
100
101       /usr/local/etc/dovecot/conf.d/90-sieve.conf
102              Sieve interpreter settings (included from Dovecot's main config‐
103              uration file)
104

REPORTING BUGS

106       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
107       <dovecot@dovecot.org>.  Information about reporting Dovecot and Pigeon‐
108       hole bugs is available at: http://dovecot.org/bugreport.html
109