dovecot-2.2: lib-storage: Added MAILBOX_ATTRIBUTE_DOVECOT_PREFIX...

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/0ed27889cd70
changeset: 15756:0ed27889cd70
user:      Timo Sirainen <tss at iki.fi>
date:      Mon Feb 11 02:03:13 2013 +0200
description:
lib-storage: Added MAILBOX_ATTRIBUTE_DOVECOT_PREFIX macro.

diffstat:

 src/lib-storage/mail-storage.h |  8 +++++++-
 1 files changed, 7 insertions(+), 1 deletions(-)

diffs (25 lines):

diff -r b9b8286fd9fd -r 0ed27889cd70 src/lib-storage/mail-storage.h
--- a/src/lib-storage/mail-storage.h	Mon Feb 11 01:43:25 2013 +0200
+++ b/src/lib-storage/mail-storage.h	Mon Feb 11 02:03:13 2013 +0200
@@ -199,6 +199,10 @@
 	MAILBOX_SYNC_TYPE_MODSEQ	= 0x04
 };
 
+/* RFC 5464 specifies that this is vendor/<vendor-token>/. The registered
+   vendor-tokens always begin with "vendor." so there's some redundancy.. */
+#define MAILBOX_ATTRIBUTE_PREFIX_DOVECOT "vendor/vendor.dovecot/"
+
 enum mail_attribute_type {
 	MAIL_ATTRIBUTE_TYPE_PRIVATE,
 	MAIL_ATTRIBUTE_TYPE_SHARED
@@ -530,7 +534,9 @@
    (as opposed to flags shared between users). */
 enum mail_flags mailbox_get_private_flags_mask(struct mailbox *box);
 
-/* Set mailbox attribute key to value. */
+/* Set mailbox attribute key to value. The key should be compatible with
+   IMAP METADATA, so for Dovecot-specific keys use
+   MAILBOX_ATTRIBUTE_PREFIX_DOVECOT. */
 int mailbox_attribute_set(struct mailbox *box, enum mail_attribute_type type,
 			  const char *key, const char *value);
 /* Delete mailbox attribute key. */