mail-storage.h revision b1f57b7183fe44d7d7ba30b944d3de1f015b9253
#ifndef __MAIL_STORAGE_H
#define __MAIL_STORAGE_H
struct message_size;
#include "imap-util.h"
enum mailbox_open_flags {
MAILBOX_OPEN_READONLY = 0x01,
MAILBOX_OPEN_FAST = 0x02,
MAILBOX_OPEN_MMAP_INVALIDATE = 0x04
};
enum mailbox_list_flags {
MAILBOX_LIST_SUBSCRIBED = 0x01,
MAILBOX_LIST_FAST_FLAGS = 0x02,
MAILBOX_LIST_CHILDREN = 0x04
};
enum mailbox_flags {
MAILBOX_NOSELECT = 0x001,
MAILBOX_NONEXISTENT = 0x002,
MAILBOX_PLACEHOLDER = 0x004,
MAILBOX_CHILDREN = 0x008,
MAILBOX_NOCHILDREN = 0x010,
MAILBOX_NOINFERIORS = 0x020,
MAILBOX_MARKED = 0x040,
MAILBOX_UNMARKED = 0x080,
MAILBOX_READONLY = 0x100
};
enum mailbox_status_items {
STATUS_MESSAGES = 0x01,
STATUS_RECENT = 0x02,
STATUS_UIDNEXT = 0x04,
STATUS_UIDVALIDITY = 0x08,
STATUS_UNSEEN = 0x10,
STATUS_FIRST_UNSEEN_SEQ = 0x20,
STATUS_CUSTOM_FLAGS = 0x40
};
enum mailbox_name_status {
};
enum mailbox_lock_type {
MAILBOX_LOCK_UNLOCK = 0x00,
MAILBOX_LOCK_READ = 0x01,
MAILBOX_LOCK_FLAGS = 0x02,
MAILBOX_LOCK_EXPUNGE = 0x04,
MAILBOX_LOCK_SAVE = 0x08
};
enum mail_sort_type {
/* Maximum size for sort program, 2x for reverse + END */
MAIL_SORT_ARRIVAL = 0x0010,
MAIL_SORT_CC = 0x0020,
MAIL_SORT_DATE = 0x0040,
MAIL_SORT_FROM = 0x0080,
MAIL_SORT_SIZE = 0x0100,
MAIL_SORT_SUBJECT = 0x0200,
MAIL_SORT_TO = 0x0400,
};
enum mail_thread_type {
};
enum mail_fetch_field {
MAIL_FETCH_FLAGS = 0x0001,
MAIL_FETCH_MESSAGE_PARTS = 0x0002,
MAIL_FETCH_RECEIVED_DATE = 0x0004,
MAIL_FETCH_DATE = 0x0008,
MAIL_FETCH_SIZE = 0x0010,
MAIL_FETCH_STREAM_HEADER = 0x0020,
MAIL_FETCH_STREAM_BODY = 0x0040,
/* specials: */
MAIL_FETCH_IMAP_BODY = 0x1000,
MAIL_FETCH_IMAP_BODYSTRUCTURE = 0x2000,
MAIL_FETCH_IMAP_ENVELOPE = 0x4000
};
enum mailbox_sync_flags {
MAILBOX_SYNC_NONE = 0x00,
MAILBOX_SYNC_FULL = 0x01,
MAILBOX_SYNC_FAST = 0x02,
};
enum client_workarounds {
WORKAROUND_OE6_FETCH_NO_NEWMAIL = 0x01,
WORKAROUND_OUTLOOK_IDLE = 0x04
};
struct mail_storage;
struct mail_storage_callbacks;
struct mailbox_list;
struct mailbox_status;
struct mail_search_arg;
struct fetch_context;
struct search_context;
/* All methods returning int return either TRUE or FALSE. */
struct mail_storage {
char *name;
char *namespace;
char hierarchy_sep;
/* Create new instance. If namespace is non-NULL, all mailbox names
are expected to begin with it. hierarchy_sep overrides the default
separator if it's not '\0'. */
const char *namespace,
char hierarchy_sep);
/* Free this instance */
/* Returns TRUE if this storage would accept the given data
as a valid parameter to create(). */
int (*autodetect)(const char *data);
/* Set storage callback functions to use. */
struct mail_storage_callbacks *callbacks,
void *context);
/* Open a mailbox. If readonly is TRUE, mailbox must not be
modified in any way even when it's asked. If fast is TRUE,
any extra time consuming operations shouldn't be performed
(eg. when opening mailbox just for STATUS).
Note that append and copy may open the selected mailbox again
with possibly different readonly-state. */
const char *name,
enum mailbox_open_flags flags);
/* name is allowed to contain multiple new hierarchy levels.
If directory is TRUE, the mailbox should be created so that it
can contain children. The mailbox itself doesn't have to be
created as long as it shows in LIST. */
int directory);
/* Only the specified mailbox is deleted, ie. folders under the
specified mailbox must not be deleted. */
/* If the name has inferior hierarchical names, then the inferior
hierarchical names MUST also be renamed (ie. foo -> bar renames
hierarchies.
If oldname is case-insensitively "INBOX", the mails are moved
into new folder but the INBOX folder must not be deleted. */
const char *newname);
/* Initialize new mailbox list request. mask may contain '%' and '*'
wildcards as defined in RFC2060. Matching against "INBOX" is
case-insensitive, but anything else is not. */
struct mailbox_list_context *
const char *mask,
enum mailbox_list_flags flags);
/* Deinitialize mailbox list request. Returns FALSE if some error
occured while listing. */
/* Get next mailbox. Returns the mailbox name */
struct mailbox_list *
/* Subscribe/unsubscribe mailbox. There should be no error when
subscribing to already subscribed mailbox. Subscribing to
unexisting mailboxes is optional. */
/* Returns mailbox name status */
const char *name,
enum mailbox_name_status *status);
/* Returns the error message of last occured error. */
int *syntax_error);
/* private: */
char *dir; /* root directory */
char *inbox_file; /* INBOX file for mbox */
char *index_dir;
char *control_dir;
char *user; /* name of user accessing the storage */
char *error;
struct mail_storage_callbacks *callbacks;
void *callback_context;
};
struct mailbox {
char *name;
struct mail_storage *storage;
/* Returns TRUE if mailbox is read-only. */
/* Returns TRUE if mailbox supports adding custom flags. */
/* Close the box. Returns FALSE if some cleanup errors occured, but
the mailbox was closed anyway. */
/* Explicitly lock the mailbox. If not used, all the methods below
use the minimum locking requirements. This allows you to for
example use the update_flags() method in struct mail. The mailbox
stays locked until you unlock it. Note that if you call a method
which wants more locks than you've given here, the call will fail
(to avoid deadlocks). */
/* Gets the mailbox status information. */
struct mailbox_status *status);
/* Synchronize the mailbox. */
/* Synchronize mailbox in background. It's done until this function is
called with flags = MAILBOX_SYNC_NONE. */
unsigned int min_newmail_notify_interval);
/* Simplified fetching for a single UID or sequence. Must be called
between fetch_init() .. fetch_deinit() or
search_init() .. search_deinit() */
enum mail_fetch_field wanted_fields);
enum mail_fetch_field wanted_fields);
/* Modify sort_program to specify a sort program acceptable for
search_init(). If mailbox supports no sorting, it's simply set to
{MAIL_SORT_END}. */
enum mail_sort_type *sort_program);
/* Initialize new search request. Search arguments are given so that
the storage can optimize the searching as it wants.
If sort_program is non-NULL, it requests that the returned messages
are sorted by the given criteria. sort_program must have gone
through search_get_sorting().
wanted_fields and wanted_headers aren't required, but they can be
used for optimizations. */
struct mail_search_context *
struct mail_search_arg *args,
const enum mail_sort_type *sort_program,
const char *const wanted_headers[]);
/* Deinitialize search request. all_found is set to TRUE if all of the
messages in search range were found. */
/* Search the next message. Returned mail object can be used until
the next call to search_next() or search_deinit(). */
/* Initialize saving one or more mails. If transaction is TRUE, all
the saved mails are deleted if an error occurs or save_deinit()
is called with rollback TRUE. */
int transaction);
/* Deinitialize saving. rollback has effect only if save_init() was
called with transaction being TRUE. If rollback is FALSE but
committing the changes fails, all the commits are rollbacked if
possible. */
/* Save a mail into mailbox. timezone_offset specifies the timezone in
minutes in which received_date was originally given with. */
const struct mail_full_flags *flags,
/* Initialize copying operation to this mailbox. The actual copying
can be done by fetching or searching mails and calling mail's
copy() method. */
/* Finish copying. */
/* Copy given message. */
/* Initialize expunging operation to this mailbox. If expunge_all
is TRUE, all messages are returned rather than just deleted. */
struct mail_expunge_context *
int expunge_all);
/* Finish expunging. */
/* Fetch next mail. */
/* Returns TRUE if mailbox is now in inconsistent state, meaning that
the message IDs etc. may have changed - only way to recover this
would be to fully close the mailbox and reopen it. With IMAP
connection this would mean a forced disconnection since we can't
do forced CLOSE. */
};
struct mail {
/* always set */
unsigned int seq;
unsigned int uid;
/* Get the time message was received (IMAP INTERNALDATE).
Returns (time_t)-1 if error occured. */
/* Get the Date-header in mail. Timezone is in minutes.
Returns (time_t)-1 if error occured, 0 if field wasn't found or
couldn't be parsed. */
/* Get the full virtual size of mail (IMAP RFC822.SIZE).
Returns (uoff_t)-1 if error occured */
/* Get value for single header field */
/* Returns partial headers which contain _at least_ the given fields,
but it may contain others as well. */
const char *const minimum_fields[]);
/* Returns input stream pointing to beginning of message header.
hdr_size and body_size are updated unless they're NULL. */
struct message_size *hdr_size,
struct message_size *body_size);
/* Get the any of the "special" fields. */
enum mail_fetch_field field);
/* Update message flags. */
const struct mail_full_flags *flags,
enum modify_type modify_type);
/* Expunge this message. Note that the actual message may or may not
be really expunged until expunge_deinit() is called. In any case,
after this call you must not try to access this mail, or any other
mail you've previously fetched.
Since you can't be sure when the message is really expunged, you
can't be sure what it's sequence number is from client's point of
view. seq_r is set to that sequence number.
This call is allowed only for mails fetched with
expunge_fetch_next(). Otherwise the sequence number updates would
get too tricky. */
};
struct mailbox_list {
const char *name;
enum mailbox_flags flags;
};
struct mailbox_status {
unsigned int messages;
unsigned int recent;
unsigned int unseen;
unsigned int uidvalidity;
unsigned int uidnext;
unsigned int first_unseen_seq;
unsigned int diskspace_full:1;
/* may be allocated from data stack */
unsigned int custom_flags_count;
const char **custom_flags;
};
struct mail_storage_callbacks {
/* Alert: Not enough disk space */
/* "* OK <text>" */
void *context);
/* "* NO <text>" */
void *context);
/* EXPUNGE */
void *context);
/* FETCH FLAGS */
const struct mail_full_flags *flags,
void *context);
/* EXISTS, RECENT */
unsigned int messages_count,
unsigned int recent_count, void *context);
/* FLAGS, PERMANENTFLAGS */
const char *custom_flags[],
unsigned int custom_flags_count,
void *context);
};
extern enum client_workarounds client_workarounds;
extern int full_filesystem_access;
void mail_storage_init(void);
void mail_storage_deinit(void);
/* register all mail storages */
void mail_storage_register_all(void);
/* Register mail storage class with given name - all methods that are NULL
are set to default methods */
/* Create a new instance of registered mail storage class with given
storage-specific data. If data is NULL, it tries to use defaults.
May return NULL if anything fails. */
struct mail_storage *
const char *namespace, char hierarchy_sep);
struct mail_storage *
mail_storage_create_default(const char *user,
const char *namespace, char hierarchy_sep);
struct mail_storage *
const char *namespace, char hierarchy_sep);
/* Set error message in storage. Critical errors are logged with i_error(),
but user sees only "internal error" message. */
int *syntax);
#endif