/* mboxlist.h -- Mailbox list manipulation routines * * Copyright (c) 1998-2003 Carnegie Mellon University. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The name "Carnegie Mellon University" must not be used to * endorse or promote products derived from this software without * prior written permission. For permission or any other legal * details, please contact * Office of Technology Transfer * Carnegie Mellon University * 5000 Forbes Avenue * Pittsburgh, PA 15213-3890 * (412) 268-4387, fax: (412) 268-7395 * tech-transfer@andrew.cmu.edu * * 4. Redistributions of any form whatsoever must retain the following * acknowledgment: * "This product includes software developed by Computing Services * at Carnegie Mellon University (http://www.cmu.edu/computing/)." * * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * * $Id: mboxlist.h,v 1.5 2005/03/05 00:36:58 dasenbro Exp $ */ #ifndef INCLUDED_MBOXLIST_H #define INCLUDED_MBOXLIST_H #include "config.h" #include "cyrusdb.h" #include "mailbox.h" #include "auth.h" #include "mboxname.h" extern struct db *mbdb; /* * Maximum length of partition name. [config.c has a limit of 70] */ #define MAX_PARTITION_LEN 64 /* flags for types of mailboxes */ #define MBTYPE_REMOTE 0x01 /* Not on this server (part is remote host) */ #define MBTYPE_RESERVE 0x02 /* Reserved [mupdate/imapd] / Rename Target [imapd] (part is normal, but you are not allowed to create this mailbox, even though it doesn't actually exist */ #define MBTYPE_NETNEWS 0x04 /* Netnews Mailbox */ #define MBTYPE_MOVING 0x08 /* Mailbox in mid-transfer (part is remotehost!localpart) */ /* master name of the mailboxes file */ #define FNAME_MBOXLIST "/mailboxes.db" #define HOSTNAME_SIZE 512 /* each mailbox has the following data */ struct mbox_entry { char name[MAX_MAILBOX_NAME]; int mbtype; char partition[MAX_PARTITION_LEN]; /* holds remote machine for REMOTE mailboxes */ char acls[1]; }; /* Lookup 'name' in the mailbox list. */ int mboxlist_lookup(const char *name, char **pathp, char **aclp, struct txn **tid); /* Lookup 'name' and get more detail */ int mboxlist_detail(const char *name, int *typep, char **pathp, char **partp, char **aclp, struct txn **tid); /* insert/delete stub entries */ int mboxlist_insertremote(const char *name, int mbtype, const char *host, const char *acl, struct txn **rettid); int mboxlist_deleteremote(const char *name, struct txn **in_tid); /* Update a mailbox's entry */ int mboxlist_update(char *name, int flags, const char *part, const char *acl, int localonly); /* check user's ability to create mailbox */ int mboxlist_createmailboxcheck(char *name, int mbtype, char *partition, int isadmin, char *userid, struct auth_state *auth_state, char **newacl, char **newpartition); /* create mailbox */ /* localonly creates the local mailbox without touching mupdate */ /* forceuser allows the creation of user.x.<name> without a user.x */ /* dbonly skips filesystem operations (e.g. reconstruct) */ int mboxlist_createmailbox(char *name, int mbtype, char *partition, int isadmin, char *userid, struct auth_state *auth_state, int localonly, int forceuser, int dbonly); /* Delete a mailbox. */ /* setting local_only disables any communication with the mupdate server * and deletes the mailbox from the filesystem regardless of if it is * MBTYPE_REMOTE or not */ /* force ignores errors and just tries to wipe the mailbox off the face of * the planet */ int mboxlist_deletemailbox(const char *name, int isadmin, char *userid, struct auth_state *auth_state, int checkacl, int local_only, int force); /* Rename/move a mailbox (hierarchical) */ int mboxlist_renamemailbox(char *oldname, char *newname, char *partition, int isadmin, char *userid, struct auth_state *auth_state); /* change ACL */ int mboxlist_setacl(const char *name, const char *identifier, const char *rights, int isadmin, const char *userid, struct auth_state *auth_state); /* Find all mailboxes that match 'pattern'. */ int mboxlist_findall(struct namespace *namespace, const char *pattern, int isadmin, char *userid, struct auth_state *auth_state, int (*proc)(), void *rock); int mboxlist_findall_std(struct namespace *namespace, const char *pattern, int isadmin, char *userid, struct auth_state *auth_state, int (*proc)(), void *rock); int mboxlist_findall_alt(struct namespace *namespace, const char *pattern, int isadmin, char *userid, struct auth_state *auth_state, int (*proc)(), void *rock); /* Find subscribed mailboxes that match 'pattern'. */ int mboxlist_findsub(struct namespace *namespace, const char *pattern, int isadmin, char *userid, struct auth_state *auth_state, int (*proc)(), void *rock, int force); int mboxlist_findsub_std(struct namespace *namespace, const char *pattern, int isadmin, char *userid, struct auth_state *auth_state, int (*proc)(), void *rock, int force); int mboxlist_findsub_alt(struct namespace *namespace, const char *pattern, int isadmin, char *userid, struct auth_state *auth_state, int (*proc)(), void *rock, int force); /* given a mailbox 'name', where should we stage messages for it? 'stagedir' should be MAX_MAILBOX_PATH. */ int mboxlist_findstage(const char *name, char *stagedir, size_t sd_len); /* Change 'user's subscription status for mailbox 'name'. */ int mboxlist_changesub(const char *name, const char *userid, struct auth_state *auth_state, int add, int force); /* get name a file containing subscriptions for 'userid' */ char *mboxlist_hash_usersubs(const char *userid); /* set or create quota root */ int mboxlist_setquota(const char *root, int newquota, int force); int mboxlist_unsetquota(const char *root); /* returns a malloc() string that is the representation in the mailboxes file. for ctl_mboxlist */ char *mboxlist_makeentry(int mbtype, const char *part, const char *acl); /* open the mailboxes db */ void mboxlist_open(char *name); /* close the database */ void mboxlist_close(void); /* initialize database structures */ #define MBOXLIST_SYNC 0x02 void mboxlist_init(int flags); /* done with database stuff */ void mboxlist_done(void); /* for transactions */ int mboxlist_commit(struct txn *tid); int mboxlist_abort(struct txn *tid); #endif