mail-namespace.h revision de4d9f77d6378a416c9963963eac5ac18b75ec0b
5ce2084ada06ade9f44fc2914c34658e9a842dc1Timo Sirainen /* Namespace contains the INBOX mailbox (there can be only one) */
5ce2084ada06ade9f44fc2914c34658e9a842dc1Timo Sirainen /* Namespace is visible only by explicitly using its full prefix */
3ddbbe03fe74b3ee7b1dff4e08ec706d7880d052Timo Sirainen /* Namespace prefix is visible with LIST */
61530b48694398df42744204e35535dbe3f745c4Timo Sirainen /* Namespace prefix isn't visible with LIST, but child mailboxes are */
4bbb027a827d27d1816b8d60c5392cfd9c79e4bdTimo Sirainen /* Namespace uses its own subscriptions. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* Namespace was created automatically (for shared mailboxes) */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* Namespace has at least some usable mailboxes. Autocreated namespaces
6789ed17e7ca4021713507baf0dcf6979bb42e0cTimo Sirainen that don't have usable mailboxes may be removed automatically. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* Automatically created namespace for a user that doesn't exist. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* Don't track quota for this namespace */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* Don't enforce ACLs for this namespace */
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen /* Namespaces are sorted by their prefix length, "" comes first */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* If non-NULL, this points to a namespace with identical mail location
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen and it should be considered as the primary way to access the
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen mailboxes. This allows for example FTS plugin to avoid duplicating
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen indexes for same mailboxes when they're accessed via different
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen namespaces. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* alias_for->alias_chain_next starts each chain. The chain goes
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen through all namespaces that have the same alias_for. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen /* FIXME: we should support multiple storages in one namespace */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint mail_namespaces_init(struct mail_user *user, const char **error_r);
4c07b08af30e1065f7022980b60474f229d8cadfTimo Sirainenstruct mail_namespace *mail_namespaces_init_empty(struct mail_user *user);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Deinitialize all namespaces. mail_user_deinit() calls this automatically
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen for user's namespaces. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenvoid mail_namespaces_deinit(struct mail_namespace **namespaces);
baf1148108b7d9739626b47cc57298c36929586aTimo Sirainen/* Set storage callback functions to use in all namespaces. */
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenvoid mail_namespaces_set_storage_callbacks(struct mail_namespace *namespaces,
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Add a new storage to namespace. */
4c07b08af30e1065f7022980b60474f229d8cadfTimo Sirainenvoid mail_namespace_add_storage(struct mail_namespace *ns,
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Destroy a single namespace and remove it from user's namespaces list. */
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenvoid mail_namespace_destroy(struct mail_namespace *ns);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen/* Update hierarchy separators in given name to real_sep characters. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenconst char *mail_namespace_fix_sep(struct mail_namespace *ns, const char *name);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Skip namespace prefix and change hierarchy separators. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenconst char *mail_namespace_get_storage_name(struct mail_namespace *ns,
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen const char *name);
fd1f0e9ef52b3e157cfd1a01c464c2ac7458ab17Timo Sirainen/* Write virtual mailbox name to dest and return it. Separators are changed to
6389aeec8c26b585e583c364b48ad12adf741898Timo Sirainen virtual ones and namespace prefix is inserted except for INBOX. */
5ce2084ada06ade9f44fc2914c34658e9a842dc1Timo Sirainenconst char *mail_namespace_get_vname(struct mail_namespace *ns, string_t *dest,
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen const char *name);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Returns the default storage to use for newly created mailboxes. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenmail_namespace_get_default_storage(struct mail_namespace *ns);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Returns the hierarchy separator for mailboxes that are listed at root. */
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenchar mail_namespaces_get_root_sep(const struct mail_namespace *namespaces)
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Returns namespace based on the mailbox name's prefix. Updates mailbox to
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen be a valid name inside the namespace (prefix is skipped, hierarchy separator
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen is changed to real_sep). If no namespaces were found, returns NULL. */
79fcd3f95a6266cc62ceaa753e56dd4456ab7c4bTimo Sirainenmail_namespace_find(struct mail_namespace *namespaces, const char **mailbox);
79fcd3f95a6266cc62ceaa753e56dd4456ab7c4bTimo Sirainen/* Like above, but ignore hidden namespaces. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenmail_namespace_find_visible(struct mail_namespace *namespaces,
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen const char **mailbox);
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen/* Like above, but find only from namespaces with subscriptions flag set. */
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainenmail_namespace_find_subscribable(struct mail_namespace *namespaces,
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen const char **mailbox);
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen/* Like above, but find only from namespaces with subscriptions flag not set. */
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainenmail_namespace_find_unsubscribable(struct mail_namespace *namespaces,
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen const char **mailbox);
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen/* Returns the INBOX namespace */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenmail_namespace_find_inbox(struct mail_namespace *namespaces);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Returns TRUE if the given namespace matches the mailbox's prefix.
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen Updates mailbox name to be a valid name inside the namespace. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenbool mail_namespace_update_name(const struct mail_namespace *ns,
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen const char **mailbox);
88ea893b45d3ed8d68000921db9156c03cbe1b00Timo Sirainen/* Find a namespace with given prefix. */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenmail_namespace_find_prefix(struct mail_namespace *namespaces,
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen const char *prefix);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Like _find_prefix(), but ignore trailing separator */
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainenmail_namespace_find_prefix_nosep(struct mail_namespace *namespaces,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen const char *prefix);
2767104d81e97a109f0aa9758792bfa1da325a97Timo Sirainen/* Called internally by mailbox_list_create(). */