aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuilhem Moulin <guilhem@fripost.org>2019-07-06 19:50:06 +0200
committerGuilhem Moulin <guilhem@fripost.org>2019-07-07 04:01:55 +0200
commit550f778dbcb84a9aa67732b1fff0191b55bea24c (patch)
tree01058d5e892ce17a3d5732eb26e33db19c4ddd0b /doc
parent4b61d5e13773bf8bf25537f28d1a42f7c6473b75 (diff)
interimap: clarify that 'ignore-mailbox' is matched against internal names.
That is, without leading reference, and where the hierarchy delimiter is replaced with null characters. /!\ This changes breaks backward compatibility!
Diffstat (limited to 'doc')
-rw-r--r--doc/interimap.1.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/interimap.1.md b/doc/interimap.1.md
index 387850a..d7c3711 100644
--- a/doc/interimap.1.md
+++ b/doc/interimap.1.md
@@ -266,7 +266,10 @@ Valid options are:
: An optional Perl Compatible Regular Expressions ([PCRE]) covering
mailboxes to exclude: any ([UTF-7 encoded][RFC 2152] and unquoted)
mailbox listed in the initial `LIST` responses is ignored if it
- matches the given expression.
+ matches the given expression after trimming the reference names and
+ substituting the hiearchy delimiter with the null character. For
+ instance, specifying `^virtual(?:\x00|$)` excludes the mailbox named
+ “virtual” as well as its descendants.
Note that the *MAILBOX*es given as command-line arguments bypass the
check and are always considered for synchronization. This option is
only available in the default section.