Skip to content

Commit 0462292

Browse files
stephanboschsirainen
authored andcommitted
docs: core: plugins: Clarify driver-dependent behavior of sieve_script_name and sieve_script_bin_path settings
1 parent f999a75 commit 0462292

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/core/plugins/sieve.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,18 @@ to this driver:
261261

262262
<SettingsComponent tag="sieve-storage-file" />
263263

264+
##### `sieve_script_name`
265+
266+
If the [[setting,sieve_script_name]] setting is not configured and the Sieve
267+
script is not retrieved by name (e.g. using the
268+
[[link,sieve_include,include extension]] or by [[link,managesieve]]), the name
269+
defaults to the file name without the `.sieve` suffix.
270+
271+
##### `sieve_script_bin_path`
272+
273+
If the [[setting,sieve_script_bin_path]] setting is not configured, the binaries
274+
are stored in the same directory as the corresponding sieve scripts by default.
275+
264276
#### Example
265277

266278
```
@@ -310,8 +322,10 @@ The `dict` storage driver supports all settings described in
310322

311323
##### `sieve_script_name`
312324

313-
If the name of the Script is left unspecified and not otherwise provided by the
314-
Sieve interpreter, the name defaults to `default`.
325+
If the [[setting,sieve_script_name]] setting is not configured and the Sieve
326+
script is not retrieved by name (e.g. using the
327+
[[link,sieve_include,include extension]] or by [[link,managesieve]]), the name
328+
defaults to `default`.
315329

316330
##### `sieve_script_bin_path`
317331

@@ -509,8 +523,10 @@ storage driver:
509523

510524
##### `sieve_script_name`
511525

512-
If the name of the Script is left unspecified and not otherwise provided by the
513-
Sieve interpreter, the name defaults to `default`.
526+
If the [[setting,sieve_script_name]] setting is not configured and the Sieve
527+
script is not retrieved by name (e.g. using the
528+
[[link,sieve_include,include extension]] or by [[link,managesieve]]), the name
529+
defaults to `default`.
514530

515531
##### `sieve_script_bin_path`
516532

0 commit comments

Comments
 (0)