docs: Adjust to Pigeonhole config rewrite

Author: stephanbosch

docs/core/admin/guides/spam_reporting.md

@@ -23,10 +23,9 @@ A global configuration script is used to capture the event of moving
 messages in/out of the Spam mailbox.
 
 ::: warning
-**You cannot run scripts anywhere you want.**
+**You cannot run shell scripts anywhere you want.**
 
-Sieve allows you to only run scripts under
-[[setting_text,sieve_<extension>_bin_dir,sieve_pipe_bin_dir]]. You
+Sieve allows you to only run scripts under [[setting,sieve_pipe_bin_dir]]. You
 can't use `/usr/local/bin/my-sieve-filter.sh`, you have to put the
 script under `sieve_pipe_bin_dir` and use `my-sieve-filter.sh` in the
 script instead.
@@ -60,20 +59,30 @@ protocol imap {
   }
 }
 
-plugin {
-  sieve_plugins = sieve_imapsieve
-  sieve_implicit_extensions = +vnd.dovecot.report
+sieve_plugins {
+  sieve_imapsieve = yes
+}
+
+sieve_global_extensions {
+  vnd.dovecot.report = yes
+}
 
+mailbox Spam {
   # From elsewhere to Spam folder
-  imapsieve_mailbox1_name = Spam
-  imapsieve_mailbox1_causes = COPY
-  imapsieve_mailbox1_before = file:/etc/dovecot/report-spam.sieve
-
-  # From Spam folder to elsewhere
-  imapsieve_mailbox2_name = *
-  imapsieve_mailbox2_from = Spam
-  imapsieve_mailbox2_causes = COPY
-  imapsieve_mailbox2_before = file:/etc/dovecot/report-ham.sieve
+  sieve_script report-spam {
+    type = before
+    cause = copy
+    path = /etc/dovecot/report-spam.sieve
+  }
+}
+
+# From Spam folder to elsewhere
+imapsieve_from Spam {
+  sieve_script report-ham {
+    type = before
+    cause = copy
+    path = /etc/dovecot/report-ham.sieve
+  }
 }
 
 # Needed to send message to external mail server
@@ -160,23 +169,34 @@ protocol imap {
   }
 }
 
-plugin {
-  sieve_plugins = sieve_imapsieve
-  sieve_implicit_extensions = +vnd.dovecot.report
+sieve_plugins {
+  sieve_imapsieve = yes
+  sieve_extprograms = yes
+}
 
+sieve_global_extensions {
+  vnd.dovecot.pipe = yes
+  vnd.dovecot.environment = yes
+}
+
+sieve_pipe_bin_dir = /usr/lib/dovecot/sieve
+
+mailbox Spam {
   # From elsewhere to Spam folder
-  imapsieve_mailbox1_name = Spam
-  imapsieve_mailbox1_causes = COPY
-  imapsieve_mailbox1_before = file:/etc/dovecot/report-spam.sieve
-
-  # From Spam folder to elsewhere
-  imapsieve_mailbox2_name = *
-  imapsieve_mailbox2_from = Spam
-  imapsieve_mailbox2_causes = COPY
-  imapsieve_mailbox2_before = file:/etc/dovecot/report-ham.sieve
-
-  sieve_pipe_bin_dir = /usr/lib/dovecot/sieve
-  sieve_global_extensions = +vnd.dovecot.pipe +vnd.dovecot.environment
+  sieve_script report-spam {
+    type = before
+    cause = copy
+    path = /etc/dovecot/report-spam.sieve
+  }
+}
+
+# From Spam folder to elsewhere
+imapsieve_from Spam {
+  sieve_script report-ham {
+    type = before
+    cause = copy
+    path = /etc/dovecot/report-ham.sieve
+  }
 }
 ```
 

docs/core/config/sieve/extensions/duplicate.md

@@ -34,10 +34,10 @@ The duplicate extension is available by default.
 ### Example
 
 ```[dovecot.conf]
-plugin {
-  sieve = ~/.dovecot.sieve
-
-  sieve_duplicate_default_period = 1h
-  sieve_duplicate_max_period = 1d
+sieve_script personal {
+  path = ~/.dovecot.sieve
 }
+
+sieve_duplicate_default_period = 1h
+sieve_duplicate_max_period = 1d
 ```

docs/core/config/sieve/extensions/editheader.md

@@ -18,25 +18,25 @@ enabled explicitly by adding it to [[setting,sieve_extensions]].
 
 ### Settings
 
-::: warning
-Invalid values for these settings will make the Sieve interpreter
-log a warning and revert to the default values.
-:::
-
 <SettingsComponent tag="sieve-editheader" level="3" />
 
 ### Example
 
 ```
-plugin {
-  # Use editheader
-  sieve_extensions = +editheader
+# Use editheader
+sieve_extensions {
+  editheader = yes
+}
 
-  # Header fields must not exceed one kilobyte
-  sieve_editheader_max_header_size = 1k
+# Header fields must not exceed one kilobyte
+sieve_editheader_max_header_size = 1k
 
-  # Protected special headers
-  sieve_editheader_forbid_add = X-Verified
-  sieve_editheader_forbid_delete = X-Verified X-Seen
+# Protected special headers
+sieve_editheader_header X-Verified {
+  forbid_add = yes
+  forbid_delete = yes
+}
+sieve_editheader_header X-Seen {
+  forbid_delete = yes
 }
 ```

docs/core/config/sieve/extensions/spamtest_virustest.md

@@ -47,14 +47,15 @@ X-Spam-Score: No, score=-3.2
 ```
 
 ```[dovecot.conf]
-plugin {
-  sieve_extensions = +spamtest +spamtestplus
-
-  sieve_spamtest_status_type = score
-  sieve_spamtest_status_header = \
-      X-Spam-Score: [[:alnum:]]+, score=(-?[[:digit:]]+\.[[:digit:]])
-  sieve_spamtest_max_value = 5.0
+sieve_extensions {
+  spamtest = yes
+  spamtestplus = yes
 }
+
+sieve_spamtest_status_type = score
+sieve_spamtest_status_header = \
+  X-Spam-Score: [[:alnum:]]+, score=(-?[[:digit:]]+\.[[:digit:]])
+sieve_spamtest_score_max_value = 5.0
 ```
 :::
 
@@ -64,13 +65,16 @@ X-Spam-Status: Yes
 ```
 
 ```[dovecot.conf]
-plugin {
-  sieve_extensions = +spamtest +spamtestplus
+sieve_extensions {
+  spamtest = yes
+  spamtestplus = yes
+}
 
-  sieve_spamtest_status_type = text
-  sieve_spamtest_status_header = X-Spam-Status
-  sieve_spamtest_text_value1 = No
-  sieve_spamtest_text_value10 = Yes
+sieve_spamtest_status_type = text
+sieve_spamtest_status_header = X-Spam-Status
+sieve_spamtest_text_value {
+  1 = No
+  10 = Yes
 }
 ```
 :::
@@ -81,13 +85,14 @@ X-Spam-Score: sssssss
 ```
 
 ```[dovecot.conf]
-plugin {
-  sieve_extensions = +spamtest +spamtestplus
-
-  sieve_spamtest_status_header = X-Spam-Score
-  sieve_spamtest_status_type = strlen
-  sieve_spamtest_max_value = 5
+sieve_extensions {
+  spamtest = yes
+  spamtestplus = yes
 }
+
+sieve_spamtest_status_header = X-Spam-Score
+sieve_spamtest_status_type = strlen
+sieve_spamtest_score_max_value = 5
 ```
 
 ::: code-group
@@ -100,19 +105,23 @@ X-Virus-Scan: Found to be clean.
 ```
 
 ```[dovecot.conf]
-plugin {
-  sieve_extensions = +spamtest +spamtestplus +virustest
-
-  sieve_spamtest_status_type = score
-  sieve_spamtest_status_header = \
-      X-Spam-Score: score=(-?[[:digit:]]+\.[[:digit:]]).*
-  sieve_spamtest_max_header = \
-      X-Spam-Score: score=-?[[:digit:]]+\.[[:digit:]] required=([[:digit:]]+\.[[:digit:]])
-
-  sieve_virustest_status_type = text
-  sieve_virustest_status_header = X-Virus-Scan: Found to be (.+)\.
-  sieve_virustest_text_value1 = clean
-  sieve_virustest_text_value5 = infected
+sieve_extensions {
+  spamtest = yes
+  spamtestplus = yes
+  virustest = yes
+}
+
+sieve_spamtest_status_type = score
+sieve_spamtest_status_header = \
+    X-Spam-Score: score=(-?[[:digit:]]+\.[[:digit:]]).*
+sieve_spamtest_score_max_header = \
+    X-Spam-Score: score=-?[[:digit:]]+\.[[:digit:]] required=([[:digit:]]+\.[[:digit:]])
+
+sieve_virustest_status_type = text
+sieve_virustest_status_header = X-Virus-Scan: Found to be (.+)\.
+sieve_virustest_text_value {
+  1 = clean
+  5 = infected
 }
 ```
 :::

docs/core/config/sieve/extensions/vacation.md

@@ -33,11 +33,6 @@ period of less than a day.
 
 ### Settings
 
-::: warning
-Invalid values for these settings will make the Sieve interpreter
-log a warning and revert to the default values.
-:::
-
 <SettingsComponent tag="sieve-vacation" level="3" />
 
 ### Auto-Reply
@@ -100,17 +95,17 @@ The automatic replies aren't sent if any of the following is true:
 ### Example
 
 ```[dovecot.conf]
-plugin {
-  # Use vacation-seconds
-  sieve_extensions = +vacation-seconds
+# Use vacation-seconds
+sieve_extensions {
+  vacation-seconds = yes
+}
 
-  # One hour at minimum
-  sieve_vacation_min_period = 1h
+# One hour at minimum
+sieve_vacation_min_period = 1h
 
-  # Ten days default
-  sieve_vacation_default_period = 10d
+# Ten days default
+sieve_vacation_default_period = 10d
 
-  # Thirty days at maximum
-  sieve_vacation_max_period = 30d
-}
+# Thirty days at maximum
+sieve_vacation_max_period = 30d
 ```

docs/core/config/sieve/index.md

@@ -36,7 +36,8 @@ about the extensions from the Sieve Mail Filtering Language Charter
 or the [Sieve.info wiki page](http://sieve.info/).
 
 ::: info
-Sieve doesn't support running external programs.
+Standard Sieve does not support running external programs. However, Dovecot
+provides non-standard extensions that provide limited support for doing that.
 :::
 
 ### Extensions
@@ -188,22 +189,30 @@ global scripts using the `sievec` command line tool. For example:
 sievec /var/lib/dovecot/sieve/global/
 ```
 
-This is necessary for scripts listed in [[setting,sieve_global]],
-[[setting,sieve_before]], and [[setting,sieve_after]] settings.
+This is necessary for script in storages with
+[[link,sieve_storage_type_after,after]],
+[[link,sieve_storage_type_before,before]],
+[[link,sieve_storage_type_default,default]], and
+[[link,sieve_storage_type_global,global]] storage type.
 
 For global scripts that are only included in other scripts using the Sieve
-include extension, this step is not necessary since included scripts
-are incorporated into the binary produced for the main script.
+include extension (from the `personal` and `global` storage types), this step is
+not necessary since included scripts are incorporated into the binary produced
+for the main script.
 
 ## Compile and Runtime Logging
 
 Log messages produced during script compilation or during script
 execution are written to two locations by the LDA Sieve plugin:
 
-- A log file is written in the same directory as the user's main
-  private script (as specified by [[setting,sieve]]). This
-  log file bears the name of that script file appended with ".log", e.g.
-  `.dovecot.sieve.log`.
+- If the user's personal storage is using the
+  [[link,sieve_storage_file,file driver]], a log file is written in the same
+  directory as the user's active personal script as defined by
+  [[setting,sieve_script_active_path]]. This log file bears the name
+  of that script file appended with ".log", e.g. `.dovecot.sieve.log`.
+  Alternatively, e.g. when using another storage driver,
+  [[setting,sieve_user_log_path]] can be used to configure the log file
+  explicitly.
 
   If there are errors or warnings in the script, the messages are appended
   to that log file until it eventually grows too large (>10 kB currently).
@@ -213,7 +222,7 @@ execution are written to two locations by the LDA Sieve plugin:
   Informational messages are not written to this log file and the log
   file is not created until messages are actually logged, i.e. when an
   error or warning is produced. The log file name can be overridden with
-  [[setting,sieve_user_log]].
+  [[setting,sieve_user_log_path]].
 
 - Messages that could be of interest to the system administrator are
   also written to the Dovecot logging facility (usually syslog). This

docs/core/config/sieve/managesieve.md

@@ -65,16 +65,11 @@ accepts a few more. The following settings can be configured in the
 ### Sieve Interpreter Configuration
 
 The part of the [[link,sieve]] configuration that is relevant
-for ManageSieve mainly consists of the settings that specify where the
-user's scripts are stored and where the active script is located.
-
-The ManageSieve service primarily uses the following Sieve interpreter
-setting in the `plugin` section of the Dovecot configuration:
-
-[[setting,sieve,file:~/sieve;active=~/.dovecot.sieve]]
-
-This specifies the [[link,sieve_location]] where the scripts that are
-uploaded through ManageSieve are stored.
+for ManageSieve mainly consists of the configuration of the `personal` Sieve
+script storage type (FIXME: ref). Currently, only the `file` Sieve script
+storage driver supports the management functions needed by Managesieve. For
+ManageSieve, the configuration of [[setting,sieve_script_active_path]] is
+required.
 
 ### Quota Support
 
@@ -165,10 +160,10 @@ protocol sieve {
   #managesieve_max_compile_errors = 5
 }
 
-
-plugin {
-  # Used by both the Sieve plugin and the ManageSieve protocol
-  sieve = file:~/sieve;active=~/.dovecot.sieve
+# Used by both the Sieve plugin and the ManageSieve protocol
+sieve_script personal {
+  path = ~/sieve
+  active_path = ~/.dovecot.sieve
 }
 ```