src/lib-storage/mailbox-list.h

	mailbox-list.h revision 1f149331f29809def8f1874312b969408ea60985
#ifndef MAILBOX_LIST_H
#define MAILBOX_LIST_H

#include "mail-error.h"

#ifdef PATH_MAX
#  define MAILBOX_LIST_NAME_MAX_LENGTH PATH_MAX
#else
#  define MAILBOX_LIST_NAME_MAX_LENGTH 4096
#endif

struct mail_namespace;
struct mail_storage;
struct mailbox_list;

enum mailbox_list_properties {
    /* maildir_name must always be empty */
    MAILBOX_LIST_PROP_NO_MAILDIR_NAME   = 0x01,
    /* alt directories not supported */
    MAILBOX_LIST_PROP_NO_ALT_DIR        = 0x02,
    /* no support for \noselect directories, only mailboxes */
    MAILBOX_LIST_PROP_NO_NOSELECT       = 0x04,
    /* mail root directory isn't required */
    MAILBOX_LIST_PROP_NO_ROOT       = 0x08,
    /* Automatically create mailbox directories when needed */
    MAILBOX_LIST_PROP_AUTOCREATE_DIRS   = 0x10
};

enum mailbox_list_flags {
    /* Mailboxes are files, not directories. */
    MAILBOX_LIST_FLAG_MAILBOX_FILES     = 0x01,
    /* Namespace already has a mailbox list, don't assign this
       mailbox list to it. */
    MAILBOX_LIST_FLAG_SECONDARY     = 0x02
};

enum mailbox_info_flags {
    MAILBOX_NOSELECT        = 0x001,
    MAILBOX_NONEXISTENT     = 0x002,
    MAILBOX_CHILDREN        = 0x004,
    MAILBOX_NOCHILDREN      = 0x008,
    MAILBOX_NOINFERIORS     = 0x010,
    MAILBOX_MARKED          = 0x020,
    MAILBOX_UNMARKED        = 0x040,
    MAILBOX_SUBSCRIBED      = 0x080,
    MAILBOX_CHILD_SUBSCRIBED    = 0x100,
    MAILBOX_CHILD_SPECIALUSE    = 0x200,

    /* Internally used by lib-storage */
    MAILBOX_SELECT          = 0x20000000,
    MAILBOX_MATCHED         = 0x40000000
};

enum mailbox_list_path_type {
    /* Return directory's path (eg. ~/dbox/INBOX) */
    MAILBOX_LIST_PATH_TYPE_DIR,
    MAILBOX_LIST_PATH_TYPE_ALT_DIR,
    /* Return mailbox path (eg. ~/dbox/INBOX/dbox-Mails) */
    MAILBOX_LIST_PATH_TYPE_MAILBOX,
    MAILBOX_LIST_PATH_TYPE_ALT_MAILBOX,
    /* Return control directory */
    MAILBOX_LIST_PATH_TYPE_CONTROL,
    /* Return index directory ("" for in-memory) */
    MAILBOX_LIST_PATH_TYPE_INDEX,
    /* Return the private index directory (NULL if none) */
    MAILBOX_LIST_PATH_TYPE_INDEX_PRIVATE
};

enum mailbox_list_file_type {
    MAILBOX_LIST_FILE_TYPE_UNKNOWN = 0,
    MAILBOX_LIST_FILE_TYPE_FILE,
    MAILBOX_LIST_FILE_TYPE_DIR,
    MAILBOX_LIST_FILE_TYPE_SYMLINK,
    MAILBOX_LIST_FILE_TYPE_OTHER
};

struct mailbox_list_settings {
    const char *layout; /* FIXME: shouldn't be here */
    const char *root_dir;
    const char *index_dir;
    const char *index_pvt_dir;
    const char *control_dir;
    const char *alt_dir; /* FIXME: dbox-specific.. */

    const char *inbox_path;
    const char *subscription_fname;
    /* If non-empty, it means that mails exist in a maildir_name
       subdirectory. eg. if you have a directory containing directories:

       mail/
       mail/foo/
       mail/foo/Maildir

       If mailbox_name is empty, you have mailboxes "mail", "mail/foo" and
       "mail/foo/Maildir".

       If mailbox_name is "Maildir", you have a non-selectable mailbox
       "mail" and a selectable mailbox "mail/foo". */
    const char *maildir_name;
    /* if set, store mailboxes under root_dir/mailbox_dir_name/.
       this setting contains either "" or "dir/". */
    const char *mailbox_dir_name;

    /* Encode "bad" characters in mailbox names as <escape_char><hex> */
    char escape_char;
    /* Use UTF-8 mailbox names on filesystem instead of mUTF-7 */
    bool utf8;
};

struct mailbox_permissions {
    /* The actual uid/gid of the mailbox */
    uid_t file_uid;
    gid_t file_gid;

    /* mode and GID to use for newly created files/dirs.
       (gid_t)-1 is used if the default GID can be used. */
    mode_t file_create_mode, dir_create_mode;
    gid_t file_create_gid;
    /* origin (e.g. path) where the file_create_gid was got from */
    const char *file_create_gid_origin;

    bool mail_index_permissions_set;
};

/* register all drivers */
void mailbox_list_register_all(void);

void mailbox_list_register(const struct mailbox_list *list);
void mailbox_list_unregister(const struct mailbox_list *list);

const struct mailbox_list *
mailbox_list_find_class(const char *driver);

/* Returns 0 if ok, -1 if driver was unknown. */
int mailbox_list_create(const char *driver, struct mail_namespace *ns,
            const struct mailbox_list_settings *set,
            enum mailbox_list_flags flags,
            struct mailbox_list **list_r, const char **error_r);
void mailbox_list_destroy(struct mailbox_list **list);

const char *
mailbox_list_get_driver_name(const struct mailbox_list *list) ATTR_PURE;
enum mailbox_list_flags
mailbox_list_get_flags(const struct mailbox_list *list) ATTR_PURE;
struct mail_namespace *
mailbox_list_get_namespace(const struct mailbox_list *list) ATTR_PURE;
struct mail_user *
mailbox_list_get_user(const struct mailbox_list *list) ATTR_PURE;
int mailbox_list_get_storage(struct mailbox_list **list, const char *vname,
                 struct mail_storage **storage_r);
void mailbox_list_get_closest_storage(struct mailbox_list *list,
                      struct mail_storage **storage);
char mailbox_list_get_hierarchy_sep(struct mailbox_list *list);

/* Returns the mode and GID that should be used when creating new files and
   directories to the specified mailbox. (gid_t)-1 is returned if it's not
   necessary to change the default gid. */
void mailbox_list_get_permissions(struct mailbox_list *list, const char *name,
                  struct mailbox_permissions *permissions_r);
/* Like mailbox_list_get_permissions(), but for creating files/dirs to the
   mail root directory (or even the root dir itself). */
void mailbox_list_get_root_permissions(struct mailbox_list *list,
                       mode_t *file_mode_r, mode_t *dir_mode_r,
                       gid_t *gid_r, const char **gid_origin_r);
/* Create path's directory with proper permissions. */
int mailbox_list_mkdir(struct mailbox_list *list,
               const char *mailbox, const char *path) ATTR_NULL(2);
/* Like mailbox_list_mkdir(), but create path's parent parent directory.
   Since most directories are created lazily, this function can be used to
   easily create them whenever file creation fails with ENOENT. */
int mailbox_list_mkdir_parent(struct mailbox_list *list,
                  const char *mailbox, const char *path)
    ATTR_NULL(2);
/* mkdir() a root directory of given type with proper permissions. */
int mailbox_list_mkdir_root(struct mailbox_list *list, const char *path,
                enum mailbox_list_path_type type,
                const char **error_r);

/* Returns TRUE if the name doesn't contain any invalid characters.
   The create name check can be more strict. */
bool mailbox_list_is_valid_pattern(struct mailbox_list *list,
                   const char *pattern);
bool mailbox_list_is_valid_existing_name(struct mailbox_list *list,
                     const char *name);
bool mailbox_list_is_valid_create_name(struct mailbox_list *list,
                       const char *name);

const char *mailbox_list_get_storage_name(struct mailbox_list *list,
                      const char *vname);
const char *mailbox_list_get_vname(struct mailbox_list *list, const char *name);

/* Return full path for the given mailbox name. The name must be a valid
   existing mailbox name. For INDEX=MEMORY it returns "" as the path. */
const char *mailbox_list_get_path(struct mailbox_list *list, const char *name,
                  enum mailbox_list_path_type type);
/* Returns root directory path for given type. */
const char *mailbox_list_get_root_path(struct mailbox_list *list,
                       enum mailbox_list_path_type type);
/* Returns mailbox's change log, or NULL if it doesn't have one. */
struct mailbox_log *mailbox_list_get_changelog(struct mailbox_list *list);
/* Specify timestamp to use when writing mailbox changes to changelog.
   The same timestamp is used until stamp is set to (time_t)-1, after which
   current time is used */
void mailbox_list_set_changelog_timestamp(struct mailbox_list *list,
                      time_t stamp);

/* Returns a prefix that temporary files should use without conflicting
   with the namespace. */
const char *mailbox_list_get_temp_prefix(struct mailbox_list *list);
/* Returns prefix that's common to all get_temp_prefix() calls.
   Typically this returns either "temp." or ".temp.". */
const char *mailbox_list_get_global_temp_prefix(struct mailbox_list *list);

/* Subscribe/unsubscribe mailbox. There should be no error when
   subscribing to already subscribed mailbox. Subscribing to
   unexisting mailboxes is optional. */
int mailbox_list_set_subscribed(struct mailbox_list *list,
                const char *name, bool set);

/* Delete a non-selectable mailbox. Fail if the mailbox is selectable. */
int mailbox_list_delete_dir(struct mailbox_list *list, const char *name);
/* Delete a symlinked mailbox. Fail if the mailbox isn't a symlink. */
int mailbox_list_delete_symlink(struct mailbox_list *list, const char *name);

/* Returns the error message of last occurred error. */
const char * ATTR_NOWARN_UNUSED_RESULT
mailbox_list_get_last_error(struct mailbox_list *list,
                enum mail_error *error_r);

#endif