sieve1
A mail filtering tool.
Usage
sieve [OPTION ...]
SCRIPT
Overview
GNU sieve -- a mail filtering tool.
-c,--[no-]compile-only-
compile script and exit
-
-D, --dump -
compile script, dump disassembled sieve code to terminal and exit
-
-d, --debug[=FLAGS] -
debug flags (defaults to "TPt")
-E,--[no-]expression-
treat SCRIPT as Sieve program text
-
-e, --email=ADDRESS -
override user email address
-
--environment=NAME=VALUE -
set sieve environment value
-
-f, --mbox-url=MBOX -
mailbox to sieve (defaults to user's mail spool)
-k,--[no-]keep-going-
keep on going if execution fails on a message
-
--line-info=BOOL -
print source location along with action logs (default)
-n,--[no-]dry-run,--no-actions-
do not execute any actions, just print what would be done
-
--no-program-name -
do not prefix diagnostic messages with the program name
-
-t, --ticket=TICKET -
ticket file for user authentication
-v,--[no-]verbose-
log all actions
-
--variable=NAME=VALUE -
set sieve variable
-
Global debugging settings
-
--debug-level=LEVEL -
set Mailutils debugging level
--[no-]debug-line-info show source info with debugging messages
-
--log-facility=FACILITY -
output logs to syslog FACILITY
-
-M, --mailer=MAILER -
use specified URL as the default mailer
-
Sieve options
-
--clear-include-path -
clear Sieve include path
-
--clear-library-path, --clearpath -
clear Sieve library path
-
-I, --includedir=DIR -
append DIR to the list of directories searched for include files
-
-L, --libdir=DIR -
append DIR to the list of directories searched for library files
-
--libdir-prefix=DIR -
add DIR to the beginning of the list of directories searched for library files
-
Configuration handling
-
--config-file=FILE -
load this configuration file; implies
--no-config
-
--config-lint -
check configuration file syntax and exit
-
--config-verbose -
verbosely log parsing of the configuration files
-
--no-config -
do not load site and user configuration files
-
--no-site-config -
do not load site-wide configuration file
-
--no-user-config -
do not load user configuration file
-
--set=PARAM=VALUE -
set configuration parameter
-
Informational options
-
--config-help -
show configuration file summary
-
--show-config-options -
show compilation options
-
-?, --help -
give this help list
-
--usage -
give a short usage message
-
-V, --version -
print program version
Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
Sieve-specific debug levels:
trace1 - print parse tree before optimization trace2 - print parse tree after optimization trace3 - print parser traces trace4 - print tests and actions being executed trace9 - print each Sieve instruction being executed
Compatibility debug flags: g - main parser traces T - mailutils traces (same as --debug-level=sieve.trace0-trace1) P - network protocols (same as --debug-level=sieve.=prot) t - sieve trace (same as --debug-level=sieve.=trace4) i - sieve instructions trace (same as --debug-level=sieve.=trace9)
History
- Debian 13 (Trixie): the text shown here
- Debian 12 (Bookworm)
- Debian 11 (Bullseye)
- Debian 10 (Buster)
- Debian 9 (Stretch)
- Debian 8 (Jessie)
- Debian 7 (Wheezy)
- Debian 6.0 (Squeeze)
- Debian 5.0 (Lenny)
- Debian 4.0 (Etch)
- Debian 3.1 (Sarge)
- Debian 3.0 (Woody)
--clear-include-path since Debian 6.0 (Squeeze);
--clear-library-path since Debian 6.0 (Squeeze);
--clearpath since Debian 5.0 (Lenny);
--config-file since Debian 6.0 (Squeeze);
--config-help since Debian 6.0 (Squeeze);
--config-lint since Debian 6.0 (Squeeze);
--config-verbose since Debian 6.0 (Squeeze);
--debug since Debian 3.1 (Sarge);
--debug-level since Debian 6.0 (Squeeze);
--dump since Debian 3.1 (Sarge);
--email since Debian 3.1 (Sarge);
--environment since Debian 9 (Stretch);
--help since Debian 3.1 (Sarge);
--includedir since Debian 3.1 (Sarge);
--libdir since Debian 3.1 (Sarge);
--libdir-prefix since Debian 7 (Wheezy);
--line-info since Debian 3.1 (Sarge);
--log-facility since Debian 3.1 (Sarge);
--mailer since Debian 3.1 (Sarge);
--mbox-url since Debian 3.1 (Sarge);
--no-config since Debian 9 (Stretch);
--no-program-name since Debian 6.0 (Squeeze);
--no-site-config since Debian 6.0 (Squeeze);
--no-user-config since Debian 6.0 (Squeeze);
--set since Debian 7 (Wheezy);
--show-config-options since Debian 6.0 (Squeeze);
--ticket since Debian 3.1 (Sarge);
--usage since Debian 3.1 (Sarge);
--variable since Debian 10 (Buster);
--version since Debian 3.1 (Sarge);
-? since Debian 3.1 (Sarge);
-D since Debian 3.1 (Sarge);
-I since Debian 3.1 (Sarge);
-L since Debian 3.1 (Sarge);
-M since Debian 3.1 (Sarge);
-V since Debian 3.1 (Sarge);
-d since Debian 3.1 (Sarge);
-e since Debian 3.1 (Sarge);
-f since Debian 3.1 (Sarge);
-t since Debian 3.1 (Sarge).
--compile-only until Debian 9 (Stretch);
--debug-line-info until Debian 9 (Stretch);
--dry-run until Debian 9 (Stretch);
--expression until Debian 9 (Stretch);
--keep-going until Debian 9 (Stretch);
--license until Debian 6.0 (Squeeze);
--lock-expire-timeout until Debian 5.0 (Lenny);
--lock-flags until Debian 5.0 (Lenny);
--lock-retry-count until Debian 5.0 (Lenny);
--lock-retry-timeout until Debian 5.0 (Lenny);
--mail-spool until Debian 5.0 (Lenny);
--mailbox-type until Debian 5.0 (Lenny);
--no-actions until Debian 9 (Stretch);
--no-site-rcfile until Debian 8 (Jessie);
--no-user-rcfile until Debian 8 (Jessie);
--rcfile until Debian 8 (Jessie);
--rcfile-lint until Debian 8 (Jessie);
--rcfile-verbose until Debian 8 (Jessie);
--tls until Debian 6.0 (Squeeze);
--verbose until Debian 9 (Stretch);
-E until Debian 9 (Stretch);
-c until Debian 9 (Stretch);
-k until Debian 9 (Stretch);
-m until Debian 5.0 (Lenny);
-n until Debian 9 (Stretch);
-v until Debian 9 (Stretch).