mailbox-attribute.h revision bf79967ee56a3f7c99012997c1834452594fed41
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* RFC 5464 specifies that this is vendor/<vendor-token>/. The registered
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch vendor-tokens always begin with "vendor." so there's some redundancy.. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch#define MAILBOX_ATTRIBUTE_PREFIX_DOVECOT "vendor/vendor.dovecot/"
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Prefix used for attributes reserved for Dovecot's internal use. Normal
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch users cannot access these in any way. */
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen/* Server attributes are currently stored in INBOX under this private prefix.
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen They're under the pvt/ prefix so they won't be listed as regular INBOX
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen attributes, but unlike other pvt/ attributes it's actually possible to
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen access these attributes as regular users.
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen If INBOX is deleted, attributes under this prefix are preserved. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch#define MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT_SERVER \
69e0311cb068f20b0f285a30263068f87bc78ce3Timo Sirainen/* User can get/set all non-pvt/ attributes and also pvt/server/
69e0311cb068f20b0f285a30263068f87bc78ce3Timo Sirainen (but not pvt/server/pvt/) attributes. */
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen#define MAILBOX_ATTRIBUTE_KEY_IS_USER_ACCESSIBLE(key) \
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen (strncmp(key, MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT, \
7f0fad65a36fab61739a50ea110e243b225d5d18Timo Sirainen strlen(MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT)) != 0 || \
69e0311cb068f20b0f285a30263068f87bc78ce3Timo Sirainen (strncmp(key, MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT_SERVER, \
69e0311cb068f20b0f285a30263068f87bc78ce3Timo Sirainen strlen(MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT_SERVER)) == 0 && \
69e0311cb068f20b0f285a30263068f87bc78ce3Timo Sirainen strncmp(key, MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT_SERVER MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT, \
69e0311cb068f20b0f285a30263068f87bc78ce3Timo Sirainen strlen(MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT_SERVER MAILBOX_ATTRIBUTE_PREFIX_DOVECOT_PVT)) != 0))
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch /* mailbox_attribute_set() can set either value or value_stream.
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch mailbox_attribute_get() returns only values, but
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch mailbox_attribute_get_stream() may return either value or
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch value_stream. The caller must unreference the returned streams. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch /* Last time the attribute was changed (0 = unknown). This may be
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch returned even for values that don't exist anymore. */
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch * Internal attribute
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch /* The internal attribute serves only as a source for a default value
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch when the normal mailbox attribute storage has no entry for this
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch attribute. Otherwise it is ignored. The `set' function is called
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch only as a notification, not with the intention to store the value.
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch The value is always assigned to the normal mailbox attribute storage.
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch /* The internal attribute serves as the main source of the attribute
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch value. If the `get' function returns 0, the normal mailbox attribute
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch storage is attempted to obtain the value. The `set' function is
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch called only as a notification, not with the intention to store the
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch value. The value is assigned to the normal mailbox attribute storage.
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch /* The value for the internal attribute is never read from the normal
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch mailbox attribute storage. If the `set' function is NULL, the
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch attribute is read-only. If it is not NULL it is used to assign the
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch attribute value; it is not assigned to the normal mailbox attribute
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch const char *key;
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch /* Get the value of this internal attribute */
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch int (*get)(struct mailbox_transaction_context *t,
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch /* Set the value of this internal attribute */
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch int (*set)(struct mailbox_transaction_context *t,
bf79967ee56a3f7c99012997c1834452594fed41Stephan Bosch const struct mailbox_attribute_internal *iattr);
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch * Attribute API
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Set mailbox attribute key to value. The key should be compatible with
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch IMAP METADATA, so for Dovecot-specific keys use
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch MAILBOX_ATTRIBUTE_PREFIX_DOVECOT. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Boschint mailbox_attribute_set(struct mailbox_transaction_context *t,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch enum mail_attribute_type type, const char *key,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Delete mailbox attribute key. This is just a wrapper to
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch mailbox_attribute_set() with value->value=NULL. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Boschint mailbox_attribute_unset(struct mailbox_transaction_context *t,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch enum mail_attribute_type type, const char *key);
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Returns value for mailbox attribute key. Returns 1 if value was returned,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch 0 if value wasn't found (set to NULL), -1 if error */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Boschint mailbox_attribute_get(struct mailbox_transaction_context *t,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch enum mail_attribute_type type, const char *key,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Same as mailbox_attribute_get(), but the returned value may be either an
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch input stream or a string. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Boschint mailbox_attribute_get_stream(struct mailbox_transaction_context *t,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch enum mail_attribute_type type, const char *key,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Iterate through mailbox attributes of the given type. The prefix can be used
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch to restrict what attributes are returned. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Boschmailbox_attribute_iter_init(struct mailbox *box, enum mail_attribute_type type,
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch const char *prefix);
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Bosch/* Returns the attribute key or NULL if there are no more attributes. */
146f9076cd456ea1e9b3f8536456d9d3c962fadbStephan Boschconst char *mailbox_attribute_iter_next(struct mailbox_attribute_iter *iter);