dovecot/original-hg/dovecot-1.2: src/lib-storage/mail-storage.h annotate

annotate src/lib-storage/mail-storage.h @ 6279:f52e7d1402b5 HEAD

mail_index_view_sync_next() and mailbox_sync_next() returns now bool. Renamed void mailbox_index_view_sync_end() to int mailbox_index_view_sync_commit().

author	Timo Sirainen <tss@iki.fi>
date	Sun, 12 Aug 2007 18:16:40 +0300
parents	5f66277bbe40
children	eb7c9d8ece54

rev	line source
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	1 #ifndef __MAIL_STORAGE_H
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	2 #define __MAIL_STORAGE_H
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	3
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	4 struct message_size;
8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	5
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	6 #include "mail-types.h"
5613 f717fb4b31c0 Error handling rewrite. Timo Sirainen <tss@iki.fi> parents: 5611 diff changeset	7 #include "mail-error.h"
4808 93bc9770f938 Initial code for separation of mailbox accessing and directory layout Timo Sirainen <tss@iki.fi> parents: 4646 diff changeset	8 #include "mailbox-list.h"
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	9
5368 7d45edb81fe4 When copying/syncing a lot of mails, send "* OK Hang in there" replies to Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	10 /* If some operation is taking long, call notify_ok every n seconds. */
7d45edb81fe4 When copying/syncing a lot of mails, send "* OK Hang in there" replies to Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	11 #define MAIL_STORAGE_STAYALIVE_SECS 15
7d45edb81fe4 When copying/syncing a lot of mails, send "* OK Hang in there" replies to Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	12
3033 146897976cfa Added mail_debug setting. Moved full_filesystem_access from global variable Timo Sirainen <tss@iki.fi> parents: 3016 diff changeset	13 enum mail_storage_flags {
146897976cfa Added mail_debug setting. Moved full_filesystem_access from global variable Timo Sirainen <tss@iki.fi> parents: 3016 diff changeset	14 /* Print debugging information while initializing the storage */
146897976cfa Added mail_debug setting. Moved full_filesystem_access from global variable Timo Sirainen <tss@iki.fi> parents: 3016 diff changeset	15 MAIL_STORAGE_FLAG_DEBUG = 0x01,
146897976cfa Added mail_debug setting. Moved full_filesystem_access from global variable Timo Sirainen <tss@iki.fi> parents: 3016 diff changeset	16 /* Allow full filesystem access with absolute or relative paths. */
3260 6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	17 MAIL_STORAGE_FLAG_FULL_FS_ACCESS = 0x02,
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	18 /* Don't try to mmap() files */
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	19 MAIL_STORAGE_FLAG_MMAP_DISABLE = 0x04,
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	20 /* Don't try to write() to mmap()ed files. Required for the few
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	21 OSes that don't have unified buffer cache
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	22 (currently OpenBSD <= 3.5) */
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	23 MAIL_STORAGE_FLAG_MMAP_NO_WRITE = 0x08,
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	24 /* Remember message headers' MD5 sum */
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	25 MAIL_STORAGE_FLAG_KEEP_HEADER_MD5 = 0x10,
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	26 /* Use CRLF linefeeds when saving mails. */
4076 7f48190f868f Moved mailbox_list_flags to struct mailbox_list_context so plugins can see the flags more easily. Timo Sirainen <timo.sirainen@movial.fi> parents: 4044 diff changeset	27 MAIL_STORAGE_FLAG_SAVE_CRLF = 0x40,
4646 6c607dbab732 If the mail environment data contains mail format prefix, don't do any kind Timo Sirainen <tss@iki.fi> parents: 4613 diff changeset	28 /* Don't try to autodetect anything, require that the given data
6c607dbab732 If the mail environment data contains mail format prefix, don't do any kind Timo Sirainen <tss@iki.fi> parents: 4613 diff changeset	29 contains all the necessary information. */
4808 93bc9770f938 Initial code for separation of mailbox accessing and directory layout Timo Sirainen <tss@iki.fi> parents: 4646 diff changeset	30 MAIL_STORAGE_FLAG_NO_AUTODETECTION = 0x100,
4859 92c0994a1fcf Added MAIL_STORAGE_FLAG_NO_AUTOCREATE flag which silently fails storage Timo Sirainen <tss@iki.fi> parents: 4848 diff changeset	31 /* Don't autocreate any directories. If they don't exist,
92c0994a1fcf Added MAIL_STORAGE_FLAG_NO_AUTOCREATE flag which silently fails storage Timo Sirainen <tss@iki.fi> parents: 4848 diff changeset	32 fail to create the storage. */
92c0994a1fcf Added MAIL_STORAGE_FLAG_NO_AUTOCREATE flag which silently fails storage Timo Sirainen <tss@iki.fi> parents: 4848 diff changeset	33 MAIL_STORAGE_FLAG_NO_AUTOCREATE = 0x200,
4968 1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4939 diff changeset	34 /* Rely on O_EXCL when creating dotlocks */
5973 fe9da9c92cf4 Added MAIL_STORAGE_FLAG_NFS_FLUSH_STORAGE and Timo Sirainen <tss@iki.fi> parents: 5949 diff changeset	35 MAIL_STORAGE_FLAG_DOTLOCK_USE_EXCL = 0x400,
fe9da9c92cf4 Added MAIL_STORAGE_FLAG_NFS_FLUSH_STORAGE and Timo Sirainen <tss@iki.fi> parents: 5949 diff changeset	36 /* Flush NFS caches for mail storage / index */
fe9da9c92cf4 Added MAIL_STORAGE_FLAG_NFS_FLUSH_STORAGE and Timo Sirainen <tss@iki.fi> parents: 5949 diff changeset	37 MAIL_STORAGE_FLAG_NFS_FLUSH_STORAGE = 0x800,
fe9da9c92cf4 Added MAIL_STORAGE_FLAG_NFS_FLUSH_STORAGE and Timo Sirainen <tss@iki.fi> parents: 5949 diff changeset	38 MAIL_STORAGE_FLAG_NFS_FLUSH_INDEX = 0x1000,
5975 78fe45cdc192 Added MAIL_STORAGE_FLAG_FSYNC_DISABLE and moved FSYNC_DISABLE environment Timo Sirainen <tss@iki.fi> parents: 5973 diff changeset	39 /* Don't use fsync() or fdatasync() */
78fe45cdc192 Added MAIL_STORAGE_FLAG_FSYNC_DISABLE and moved FSYNC_DISABLE environment Timo Sirainen <tss@iki.fi> parents: 5973 diff changeset	40 MAIL_STORAGE_FLAG_FSYNC_DISABLE = 0x2000
3260 6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	41 };
6a179bf1272e Moved several getenv()s from lib-storage to main code. deliver binary was Timo Sirainen <tss@iki.fi> parents: 3254 diff changeset	42
1622 d22e03714d36 index_mmap_invalidate = yes now invalidate memory maps before accessing Timo Sirainen <tss@iki.fi> parents: 1552 diff changeset	43 enum mailbox_open_flags {
3245 6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	44 /* Mailbox must not be modified even if asked */
1622 d22e03714d36 index_mmap_invalidate = yes now invalidate memory maps before accessing Timo Sirainen <tss@iki.fi> parents: 1552 diff changeset	45 MAILBOX_OPEN_READONLY = 0x01,
4041 9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	46 /* Only saving/copying mails to mailbox works. */
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	47 MAILBOX_OPEN_SAVEONLY = 0x02,
3245 6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	48 /* Any extra time consuming operations shouldn't be performed
6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	49 (eg. when opening mailbox just for STATUS). */
4041 9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	50 MAILBOX_OPEN_FAST = 0x04,
3245 6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	51 /* Don't reset MAIL_RECENT flags when syncing */
4041 9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	52 MAILBOX_OPEN_KEEP_RECENT = 0x08,
3628 571336db01f4 Added MAILBOX_OPEN_NO_INDEX_FILES flag and made streamed mboxes by default Timo Sirainen <tss@iki.fi> parents: 3520 diff changeset	53 /* Don't create index files for the mailbox */
4152 e2edd333c473 Added MAILBOX_OPEN_KEEP_LOCKED flag to mailbox opening and implemented it Timo Sirainen <tss@iki.fi> parents: 4076 diff changeset	54 MAILBOX_OPEN_NO_INDEX_FILES = 0x10,
e2edd333c473 Added MAILBOX_OPEN_KEEP_LOCKED flag to mailbox opening and implemented it Timo Sirainen <tss@iki.fi> parents: 4076 diff changeset	55 /* Keep mailbox exclusively locked all the time while it's open */
4548 2eb8af6f1285 Added MAILBOX_OPEN_MBOX_ONE_MSG_ONLY flag for mailbox_open() which makes it Timo Sirainen <tss@iki.fi> parents: 4544 diff changeset	56 MAILBOX_OPEN_KEEP_LOCKED = 0x20,
2eb8af6f1285 Added MAILBOX_OPEN_MBOX_ONE_MSG_ONLY flag for mailbox_open() which makes it Timo Sirainen <tss@iki.fi> parents: 4544 diff changeset	57 /* FIXME: Kludge for deliver: Ignore all but the first From-line */
2eb8af6f1285 Added MAILBOX_OPEN_MBOX_ONE_MSG_ONLY flag for mailbox_open() which makes it Timo Sirainen <tss@iki.fi> parents: 4544 diff changeset	58 MAILBOX_OPEN_MBOX_ONE_MSG_ONLY = 0x40
1622 d22e03714d36 index_mmap_invalidate = yes now invalidate memory maps before accessing Timo Sirainen <tss@iki.fi> parents: 1552 diff changeset	59 };
d22e03714d36 index_mmap_invalidate = yes now invalidate memory maps before accessing Timo Sirainen <tss@iki.fi> parents: 1552 diff changeset	60
903 fd8888f6f037 Naming style changes, finally got tired of most of the typedefs. Also the Timo Sirainen <tss@iki.fi> parents: 889 diff changeset	61 enum mailbox_status_items {
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	62 STATUS_MESSAGES = 0x01,
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	63 STATUS_RECENT = 0x02,
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	64 STATUS_UIDNEXT = 0x04,
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	65 STATUS_UIDVALIDITY = 0x08,
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	66 STATUS_UNSEEN = 0x10,
100 867ec80dbf42 Custom flags are now shown in FLAGS and PERMANENTFLAGS lists after SELECT. Timo Sirainen <tss@iki.fi> parents: 50 diff changeset	67 STATUS_FIRST_UNSEEN_SEQ = 0x20,
1958 4dec6a3d79fd s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1917 diff changeset	68 STATUS_KEYWORDS = 0x40
903 fd8888f6f037 Naming style changes, finally got tired of most of the typedefs. Also the Timo Sirainen <tss@iki.fi> parents: 889 diff changeset	69 };
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	70
906 b176f913d092 "ISO C forbids forward references to enum types" Timo Sirainen <tss@iki.fi> parents: 903 diff changeset	71 enum mail_sort_type {
4303 5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	72 /* Maximum size for sort program (each one separately + END) */
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	73 #define MAX_SORT_PROGRAM_SIZE (7 + 1)
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	74
4303 5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	75 MAIL_SORT_ARRIVAL = 0x0001,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	76 MAIL_SORT_CC = 0x0002,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	77 MAIL_SORT_DATE = 0x0004,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	78 MAIL_SORT_FROM = 0x0008,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	79 MAIL_SORT_SIZE = 0x0010,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	80 MAIL_SORT_SUBJECT = 0x0020,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	81 MAIL_SORT_TO = 0x0040,
906 b176f913d092 "ISO C forbids forward references to enum types" Timo Sirainen <tss@iki.fi> parents: 903 diff changeset	82
4303 5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	83 MAIL_SORT_MASK = 0x0fff,
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	84 MAIL_SORT_FLAG_REVERSE = 0x1000, /* reverse this mask type */
906 b176f913d092 "ISO C forbids forward references to enum types" Timo Sirainen <tss@iki.fi> parents: 903 diff changeset	85
b176f913d092 "ISO C forbids forward references to enum types" Timo Sirainen <tss@iki.fi> parents: 903 diff changeset	86 MAIL_SORT_END = 0x0000 /* ends sort program */
b176f913d092 "ISO C forbids forward references to enum types" Timo Sirainen <tss@iki.fi> parents: 903 diff changeset	87 };
b176f913d092 "ISO C forbids forward references to enum types" Timo Sirainen <tss@iki.fi> parents: 903 diff changeset	88
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	89 enum mail_fetch_field {
2238 9cc23c29aaec Added a framework for getting POP3 UIDL strings from mail-storage. The Timo Sirainen <tss@iki.fi> parents: 2219 diff changeset	90 MAIL_FETCH_FLAGS = 0x00000001,
9cc23c29aaec Added a framework for getting POP3 UIDL strings from mail-storage. The Timo Sirainen <tss@iki.fi> parents: 2219 diff changeset	91 MAIL_FETCH_MESSAGE_PARTS = 0x00000002,
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	92
4455 fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	93 MAIL_FETCH_STREAM_HEADER = 0x00000004,
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	94 MAIL_FETCH_STREAM_BODY = 0x00000008,
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	95
4455 fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	96 MAIL_FETCH_DATE = 0x00000010,
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	97 MAIL_FETCH_RECEIVED_DATE = 0x00000020,
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	98 MAIL_FETCH_SAVE_DATE = 0x00000040,
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	99 MAIL_FETCH_PHYSICAL_SIZE = 0x00000080,
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	100 MAIL_FETCH_VIRTUAL_SIZE = 0x00000100,
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	101
5949 1a80f37a4a12 Added MAIL_FETCH_NUL_STATE. Don't try to fetch cached flags now unless it's Timo Sirainen <tss@iki.fi> parents: 5763 diff changeset	102 /* Set has_nuls / has_no_nuls fields */
1a80f37a4a12 Added MAIL_FETCH_NUL_STATE. Don't try to fetch cached flags now unless it's Timo Sirainen <tss@iki.fi> parents: 5763 diff changeset	103 MAIL_FETCH_NUL_STATE = 0x00000200,
1a80f37a4a12 Added MAIL_FETCH_NUL_STATE. Don't try to fetch cached flags now unless it's Timo Sirainen <tss@iki.fi> parents: 5763 diff changeset	104
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	105 /* specials: */
2238 9cc23c29aaec Added a framework for getting POP3 UIDL strings from mail-storage. The Timo Sirainen <tss@iki.fi> parents: 2219 diff changeset	106 MAIL_FETCH_IMAP_BODY = 0x00001000,
9cc23c29aaec Added a framework for getting POP3 UIDL strings from mail-storage. The Timo Sirainen <tss@iki.fi> parents: 2219 diff changeset	107 MAIL_FETCH_IMAP_BODYSTRUCTURE = 0x00002000,
9cc23c29aaec Added a framework for getting POP3 UIDL strings from mail-storage. The Timo Sirainen <tss@iki.fi> parents: 2219 diff changeset	108 MAIL_FETCH_IMAP_ENVELOPE = 0x00004000,
9cc23c29aaec Added a framework for getting POP3 UIDL strings from mail-storage. The Timo Sirainen <tss@iki.fi> parents: 2219 diff changeset	109 MAIL_FETCH_FROM_ENVELOPE = 0x00008000,
2996 9219e788d774 Added %f pop3_uidl_format for maildir. Patch by Andrey Panin. Timo Sirainen <tss@iki.fi> parents: 2976 diff changeset	110 MAIL_FETCH_HEADER_MD5 = 0x00010000,
9219e788d774 Added %f pop3_uidl_format for maildir. Patch by Andrey Panin. Timo Sirainen <tss@iki.fi> parents: 2976 diff changeset	111 MAIL_FETCH_UIDL_FILE_NAME = 0x00020000
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	112 };
8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	113
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	114 enum mailbox_transaction_flags {
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	115 /* Hide changes done in this transaction from next view sync */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	116 MAILBOX_TRANSACTION_FLAG_HIDE = 0x01,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	117 /* External transaction. Should be used for copying and appends,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	118 but nothing else. */
5572 896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	119 MAILBOX_TRANSACTION_FLAG_EXTERNAL = 0x02,
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	120 /* Always assign UIDs to messages when saving/copying. Normally this
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	121 is done only if the mailbox is synced, or if dest_mail parameter
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	122 was non-NULL to mailbox_save_init() or mailbox_copy() */
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	123 MAILBOX_TRANSACTION_FLAG_ASSIGN_UIDS = 0x04
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	124 };
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	125
1730 8480f945e270 IDLE uses now IO__NOTIFY to get instant notifying of mails. Timo Sirainen <tss@iki.fi>* parents: 1728 diff changeset	126 enum mailbox_sync_flags {
2665 ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	127 /* Make sure we sync all external changes done to mailbox */
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	128 MAILBOX_SYNC_FLAG_FULL_READ = 0x01,
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	129 /* Make sure we write all our internal changes into the mailbox */
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	130 MAILBOX_SYNC_FLAG_FULL_WRITE = 0x02,
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	131 /* If it's not too much trouble, check if there are some changes */
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	132 MAILBOX_SYNC_FLAG_FAST = 0x04,
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	133
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	134 /* Don't sync expunges from our view */
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	135 MAILBOX_SYNC_FLAG_NO_EXPUNGES = 0x08,
ccf563859be5 Split sync_flag_full into sync_flag_full_read and _write. Closing mailbox Timo Sirainen <tss@iki.fi> parents: 2589 diff changeset	136 /* Stop auto syncing */
3204 c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3138 diff changeset	137 MAILBOX_SYNC_AUTO_STOP = 0x20
1552 bc3307f2f35d Only NOOP and CHECK will now always do a real mailbox sync. Other commands Timo Sirainen <tss@iki.fi> parents: 1534 diff changeset	138 };
bc3307f2f35d Only NOOP and CHECK will now always do a real mailbox sync. Other commands Timo Sirainen <tss@iki.fi> parents: 1534 diff changeset	139
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	140 enum mailbox_sync_type {
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	141 MAILBOX_SYNC_TYPE_EXPUNGE = 0x01,
3016 61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	142 MAILBOX_SYNC_TYPE_FLAGS = 0x02,
61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	143 MAILBOX_SYNC_TYPE_KEYWORDS = 0x04
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	144 };
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	145
5500 4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for Timo Sirainen <tss@iki.fi> parents: 5461 diff changeset	146 struct mail_namespace;
903 fd8888f6f037 Naming style changes, finally got tired of most of the typedefs. Also the Timo Sirainen <tss@iki.fi> parents: 889 diff changeset	147 struct mail_storage;
fd8888f6f037 Naming style changes, finally got tired of most of the typedefs. Also the Timo Sirainen <tss@iki.fi> parents: 889 diff changeset	148 struct mail_search_arg;
3016 61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	149 struct mail_keywords;
4044 da1d65e064f8 mailbox_save_init() supports now returning failure. Quota plugin now checks Timo Sirainen <timo.sirainen@movial.fi> parents: 4041 diff changeset	150 struct mail_save_context;
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	151 struct mailbox;
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	152 struct mailbox_transaction_context;
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	153
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	154 struct mailbox_status {
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	155 uint32_t messages;
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	156 uint32_t recent;
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	157 uint32_t unseen;
674 b7aefd0d7611 Locking changes triggered a bit larger cleanup :) If we have to wait for a Timo Sirainen <tss@iki.fi> parents: 568 diff changeset	158
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	159 uint32_t uidvalidity;
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	160 uint32_t uidnext;
450 925d6eb5f8be MailStorage interface change. We now let storage call several sync-functions Timo Sirainen <tss@iki.fi> parents: 410 diff changeset	161
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	162 uint32_t first_unseen_seq;
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	163
4451 1a35d53c18fc Array API redesigned to work using unions. It now provides type safety Timo Sirainen <tss@iki.fi> parents: 4303 diff changeset	164 const ARRAY_TYPE(keywords) *keywords;
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	165 };
450 925d6eb5f8be MailStorage interface change. We now let storage call several sync-functions Timo Sirainen <tss@iki.fi> parents: 410 diff changeset	166
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	167 struct mailbox_sync_rec {
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	168 uint32_t seq1, seq2;
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	169 enum mailbox_sync_type type;
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	170 };
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	171
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	172 struct mail {
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	173 /* always set */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	174 struct mailbox *box;
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	175 struct mailbox_transaction_context *transaction;
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	176 uint32_t seq, uid;
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	177
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	178 unsigned int expunged:1;
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	179 unsigned int has_nuls:1; /* message data is known to contain NULs */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	180 unsigned int has_no_nuls:1; /* -''- known to not contain NULs */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	181 };
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	182
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	183 struct mail_storage_callbacks {
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	184 /* "* OK <text>" */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	185 void (notify_ok)(struct mailbox mailbox, const char *text,
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	186 void *context);
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	187 /* "* NO <text>" */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	188 void (notify_no)(struct mailbox mailbox, const char *text,
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	189 void *context);
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	190
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	191 };
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	192
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	193 typedef void mailbox_notify_callback_t(struct mailbox box, void context);
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	194
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	195 void mail_storage_init(void);
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	196 void mail_storage_deinit(void);
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	197
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	198 /* register all mail storages */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	199 void mail_storage_register_all(void);
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	200
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	201 /* Register mail storage class with given name - all methods that are NULL
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	202 are set to default methods */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	203 void mail_storage_class_register(struct mail_storage *storage_class);
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	204 void mail_storage_class_unregister(struct mail_storage *storage_class);
1642 72c6e848f583 API changes: Don't keep variables in mailbox class. Timo Sirainen <tss@iki.fi> parents: 1640 diff changeset	205
3971 539a58176e7b Moved mailbox flag and lock method parsing to lib-storage. Timo Sirainen <tss@iki.fi> parents: 3879 diff changeset	206 /* Returns flags and lock_method based on environment settings. */
539a58176e7b Moved mailbox flag and lock method parsing to lib-storage. Timo Sirainen <tss@iki.fi> parents: 3879 diff changeset	207 void mail_storage_parse_env(enum mail_storage_flags *flags_r,
4876 f1d77064884c Lock handling changes. Everything goes through file-lock API now and there's Timo Sirainen <tss@iki.fi> parents: 4859 diff changeset	208 enum file_lock_method *lock_method_r);
3971 539a58176e7b Moved mailbox flag and lock method parsing to lib-storage. Timo Sirainen <tss@iki.fi> parents: 3879 diff changeset	209
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	210 /* Create a new instance of registered mail storage class with given
5461 08b42ced91a6 Removed mail_storage_create_with_data(). mail_storage_create() with Timo Sirainen <tss@iki.fi> parents: 5448 diff changeset	211 storage-specific data. If driver is NULL, it's tried to be autodetected
08b42ced91a6 Removed mail_storage_create_with_data(). mail_storage_create() with Timo Sirainen <tss@iki.fi> parents: 5448 diff changeset	212 from data. If data is NULL, it uses the first storage that exists.
5500 4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for Timo Sirainen <tss@iki.fi> parents: 5461 diff changeset	213 The storage is put into ns->storage. */
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for Timo Sirainen <tss@iki.fi> parents: 5461 diff changeset	214 int mail_storage_create(struct mail_namespace ns, const char driver,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for Timo Sirainen <tss@iki.fi> parents: 5461 diff changeset	215 const char data, const char user,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for Timo Sirainen <tss@iki.fi> parents: 5461 diff changeset	216 enum mail_storage_flags flags,
6023 56879cc53cec mail_storage.create() now returns error message string. Also fixed handling Timo Sirainen <tss@iki.fi> parents: 5975 diff changeset	217 enum file_lock_method lock_method,
56879cc53cec mail_storage.create() now returns error message string. Also fixed handling Timo Sirainen <tss@iki.fi> parents: 5975 diff changeset	218 const char **error_r);
4808 93bc9770f938 Initial code for separation of mailbox accessing and directory layout Timo Sirainen <tss@iki.fi> parents: 4646 diff changeset	219 void mail_storage_destroy(struct mail_storage **storage);
1639 3621292209f4 Explicit lock() method for mailbox. Timo Sirainen <tss@iki.fi> parents: 1638 diff changeset	220
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	221 char mail_storage_get_hierarchy_sep(struct mail_storage *storage);
4808 93bc9770f938 Initial code for separation of mailbox accessing and directory layout Timo Sirainen <tss@iki.fi> parents: 4646 diff changeset	222 struct mailbox_list mail_storage_get_list(struct mail_storage storage);
5500 4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for Timo Sirainen <tss@iki.fi> parents: 5461 diff changeset	223 struct mail_namespace mail_storage_get_namespace(struct mail_storage storage);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	224
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	225 /* Set storage callback functions to use. */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	226 void mail_storage_set_callbacks(struct mail_storage *storage,
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	227 struct mail_storage_callbacks *callbacks,
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	228 void *context);
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	229
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	230 /* name is allowed to contain multiple new hierarchy levels.
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	231 If directory is TRUE, the mailbox should be created so that it
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	232 can contain children. The mailbox itself doesn't have to be
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	233 created as long as it shows in LIST. */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	234 int mail_storage_mailbox_create(struct mail_storage storage, const char name,
3863 55df57c028d4 Added "bool" type and changed all ints that were used as booleans to bool. Timo Sirainen <tss@iki.fi> parents: 3641 diff changeset	235 bool directory);
1172 f7c273202dc3 Support for IDLE extension. Timo Sirainen <tss@iki.fi> parents: 1151 diff changeset	236
3520 e2fe8222449d s/occured/occurred/ Timo Sirainen <tss@iki.fi> parents: 3517 diff changeset	237 /* Returns the error message of last occurred error. */
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	238 const char mail_storage_get_last_error(struct mail_storage storage,
5613 f717fb4b31c0 Error handling rewrite. Timo Sirainen <tss@iki.fi> parents: 5611 diff changeset	239 enum mail_error *error_r);
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	240
4041 9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	241 /* Returns path to the given mailbox, or NULL if mailbox doesn't exist in
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	242 filesystem. is_file_r is set to TRUE if returned path points to a file,
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	243 and FALSE if it points to a directory. If name is "", the root storage
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	244 directory is returned. */
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	245 const char mail_storage_get_mailbox_path(struct mail_storage storage,
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	246 const char name, bool is_file_r);
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	247 /* Returns path to the control directory of the mailbox, or NULL if mailbox
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	248 doesn't exist in filesystem. */
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	249 const char mail_storage_get_mailbox_control_dir(struct mail_storage storage,
9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	250 const char *name);
4606 baaf62ced3d0 Added mail_storage_get_mailbox_index_dir(). Timo Sirainen <tss@iki.fi> parents: 4548 diff changeset	251 /* Returns path to the index directory of the mailbox, or NULL if using
baaf62ced3d0 Added mail_storage_get_mailbox_index_dir(). Timo Sirainen <tss@iki.fi> parents: 4548 diff changeset	252 in-memory indexes or mailbox doesn't exist. */
baaf62ced3d0 Added mail_storage_get_mailbox_index_dir(). Timo Sirainen <tss@iki.fi> parents: 4548 diff changeset	253 const char mail_storage_get_mailbox_index_dir(struct mail_storage storage,
baaf62ced3d0 Added mail_storage_get_mailbox_index_dir(). Timo Sirainen <tss@iki.fi> parents: 4548 diff changeset	254 const char *name);
4041 9d7420b0e1ef Make life easier for plugins: Timo Sirainen <timo.sirainen@movial.fi> parents: 3971 diff changeset	255
3245 6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	256 /* Open a mailbox. If input stream is given, mailbox is opened read-only
6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	257 using it as a backend. If storage doesn't support stream backends and its
6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	258 tried to be used, NULL is returned.
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	259
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	260 Note that append and copy may open the selected mailbox again
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	261 with possibly different readonly-state. */
3245 6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	262 struct mailbox mailbox_open(struct mail_storage storage, const char *name,
6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	263 struct istream *input,
6491dab63e54 Added input stream parameter to mailbox_open(). With mbox it now allows Timo Sirainen <tss@iki.fi> parents: 3209 diff changeset	264 enum mailbox_open_flags flags);
3863 55df57c028d4 Added "bool" type and changed all ints that were used as booleans to bool. Timo Sirainen <tss@iki.fi> parents: 3641 diff changeset	265 /* Close the box. Returns -1 if some cleanup errors occurred, but
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	266 the mailbox was closed anyway. */
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	267 int mailbox_close(struct mailbox **box);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	268
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	269 /* Returns storage of given mailbox */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	270 struct mail_storage mailbox_get_storage(struct mailbox box);
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	271
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	272 /* Returns name of given mailbox */
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	273 const char mailbox_get_name(struct mailbox box);
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	274
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	275 /* Returns TRUE if mailbox is read-only. */
3863 55df57c028d4 Added "bool" type and changed all ints that were used as booleans to bool. Timo Sirainen <tss@iki.fi> parents: 3641 diff changeset	276 bool mailbox_is_readonly(struct mailbox *box);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	277
1958 4dec6a3d79fd s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1917 diff changeset	278 /* Returns TRUE if mailbox currently supports adding keywords. */
3863 55df57c028d4 Added "bool" type and changed all ints that were used as booleans to bool. Timo Sirainen <tss@iki.fi> parents: 3641 diff changeset	279 bool mailbox_allow_new_keywords(struct mailbox *box);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	280
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	281 /* Gets the mailbox status information. */
6275 913b188f4dd4 Removed explicit locking from views and maps. They were already locked all Timo Sirainen <tss@iki.fi> parents: 6267 diff changeset	282 void mailbox_get_status(struct mailbox *box, enum mailbox_status_items items,
913b188f4dd4 Removed explicit locking from views and maps. They were already locked all Timo Sirainen <tss@iki.fi> parents: 6267 diff changeset	283 struct mailbox_status *status_r);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	284
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	285 /* Synchronize the mailbox. */
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	286 struct mailbox_sync_context *
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	287 mailbox_sync_init(struct mailbox *box, enum mailbox_sync_flags flags);
6279 f52e7d1402b5 mail_index_view_sync_next() and mailbox_sync_next() returns now bool. Timo Sirainen <tss@iki.fi> parents: 6277 diff changeset	288 bool mailbox_sync_next(struct mailbox_sync_context *ctx,
f52e7d1402b5 mail_index_view_sync_next() and mailbox_sync_next() returns now bool. Timo Sirainen <tss@iki.fi> parents: 6277 diff changeset	289 struct mailbox_sync_rec *sync_rec_r);
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	290 int mailbox_sync_deinit(struct mailbox_sync_context **ctx,
4848 967de900c73a Mailbox list indexing and related changes. Currently works only with Timo Sirainen <tss@iki.fi> parents: 4808 diff changeset	291 enum mailbox_status_items status_items,
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	292 struct mailbox_status *status_r);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	293
4907 5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	294 /* Call given callback function when something changes in the mailbox. */
2322 aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	295 void mailbox_notify_changes(struct mailbox *box, unsigned int min_interval,
aae574ed7f4c Broke mailbox_sync() into iterator. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	296 mailbox_notify_callback_t callback, void context);
4907 5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	297 #ifdef CONTEXT_TYPE_SAFETY
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	298 # define mailbox_notify_changes(box, min_interval, callback, context) \
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	299 ({(void)(1 ? 0 : callback((struct mailbox *)NULL, context)); \
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	300 mailbox_notify_changes(box, min_interval, \
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	301 (mailbox_notify_callback_t *)callback, context); })
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	302 #else
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	303 # define mailbox_notify_changes(box, min_interval, callback, context) \
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	304 mailbox_notify_changes(box, min_interval, \
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	305 (mailbox_notify_callback_t *)callback, context)
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	306 #endif
5b4c9b20eba0 Replaced void context from a lot of callbacks with the actual context Timo Sirainen <tss@iki.fi>* parents: 4876 diff changeset	307 void mailbox_notify_changes_stop(struct mailbox *box);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	308
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	309 struct mailbox_transaction_context *
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	310 mailbox_transaction_begin(struct mailbox *box,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	311 enum mailbox_transaction_flags flags);
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	312 int mailbox_transaction_commit(struct mailbox_transaction_context **t,
2518 f8be7a5e273a Added sync flags parameter to mailbox_transaction_commit(), so EXPUNGE can Timo Sirainen <tss@iki.fi> parents: 2511 diff changeset	313 enum mailbox_sync_flags flags);
5572 896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	314 /* If no messages were saved/copied, first/last_saved_uid_r are 0. */
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	315 int mailbox_transaction_commit_get_uids(struct mailbox_transaction_context **t,
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	316 enum mailbox_sync_flags flags,
6267 3a1eed408cad mailbox_transaction_commit_get_uids() now returns also UIDVALIDITY. It's the Timo Sirainen <tss@iki.fi> parents: 6120 diff changeset	317 uint32_t *uid_validity_r,
5572 896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	318 uint32_t *first_saved_uid_r,
896845fbc4ed Added mailbox_transaction_commit_get_uids() which returns the UID range for Timo Sirainen <tss@iki.fi> parents: 5567 diff changeset	319 uint32_t *last_saved_uid_r);
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	320 void mailbox_transaction_rollback(struct mailbox_transaction_context **t);
4939 ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	321 /* Return the number of active transactions for the mailbox. */
ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	322 unsigned int mailbox_transaction_get_count(struct mailbox *box);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	323
3016 61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	324 /* Build mail_keywords from NULL-terminated keywords list. */
61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	325 struct mail_keywords *
61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	326 mailbox_keywords_create(struct mailbox_transaction_context *t,
61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	327 const char *const keywords[]);
3138 fbe844061fe2 Internal changes in how keywords are handled. struct mail_keywords isn't Timo Sirainen <tss@iki.fi> parents: 3086 diff changeset	328 void mailbox_keywords_free(struct mailbox_transaction_context *t,
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	329 struct mail_keywords **keywords);
3016 61c8d205d887 Initial support for keywords. Syncing to mbox/maildir doesn't work yet. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	330
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	331 /* Convert uid range to sequence range. */
6275 913b188f4dd4 Removed explicit locking from views and maps. They were already locked all Timo Sirainen <tss@iki.fi> parents: 6267 diff changeset	332 void mailbox_get_uids(struct mailbox *box, uint32_t uid1, uint32_t uid2,
913b188f4dd4 Removed explicit locking from views and maps. They were already locked all Timo Sirainen <tss@iki.fi> parents: 6267 diff changeset	333 uint32_t seq1_r, uint32_t seq2_r);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	334
2327 7d02e2a7672d Header caching redesigned. New design allows caching decisions per field, so Timo Sirainen <tss@iki.fi> parents: 2322 diff changeset	335 /* Initialize header lookup for given headers. */
7d02e2a7672d Header caching redesigned. New design allows caching decisions per field, so Timo Sirainen <tss@iki.fi> parents: 2322 diff changeset	336 struct mailbox_header_lookup_ctx *
7d02e2a7672d Header caching redesigned. New design allows caching decisions per field, so Timo Sirainen <tss@iki.fi> parents: 2322 diff changeset	337 mailbox_header_lookup_init(struct mailbox box, const char const headers[]);
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	338 void mailbox_header_lookup_deinit(struct mailbox_header_lookup_ctx **ctx);
2327 7d02e2a7672d Header caching redesigned. New design allows caching decisions per field, so Timo Sirainen <tss@iki.fi> parents: 2322 diff changeset	339
4303 5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	340 /* Initialize new search request. charset specifies the character set used in
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	341 the search argument strings. If sort_program is non-NULL, the messages are
5f03738219a6 Changed mail-storage API to do the mail sorting internally. Optimized it Timo Sirainen <timo.sirainen@movial.fi> parents: 4274 diff changeset	342 returned in the requested order, otherwise from first to last. */
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	343 struct mail_search_context *
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	344 mailbox_search_init(struct mailbox_transaction_context *t,
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	345 const char charset, struct mail_search_arg args,
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	346 const enum mail_sort_type *sort_program);
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	347 /* Deinitialize search request. */
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	348 int mailbox_search_deinit(struct mail_search_context **ctx);
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	349 /* Search the next message. Returns 1 if found, 0 if not, -1 if failure. */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	350 int mailbox_search_next(struct mail_search_context ctx, struct mail mail);
4939 ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	351 /* Like mailbox_search_next(), but don't spend too much time searching.
ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	352 Returns 1 if found, -1 if failure or 0 with tryagain_r=FALSE if
ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	353 finished, and TRUE if more results will by calling the function again. */
ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	354 int mailbox_search_next_nonblock(struct mail_search_context *ctx,
ff2272c228cc Dovecot is now able to execute multiple commands at the same time. Timo Sirainen <tss@iki.fi> parents: 4907 diff changeset	355 struct mail mail, bool tryagain_r);
1637 a64391b49589 API change for copying messages. Timo Sirainen <tss@iki.fi> parents: 1622 diff changeset	356
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	357 /* Save a mail into mailbox. timezone_offset specifies the timezone in
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	358 minutes in which received_date was originally given with. To use
2190 755ec9442a58 mailbox_save() and mailbox_copy() functions can now return the saved mail so Timo Sirainen <tss@iki.fi> parents: 2062 diff changeset	359 current time, set received_date to (time_t)-1.
755ec9442a58 mailbox_save() and mailbox_copy() functions can now return the saved mail so Timo Sirainen <tss@iki.fi> parents: 2062 diff changeset	360
4268 7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	361 If dest_mail is set, the saved message can be accessed using it. Note that
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	362 setting it may require mailbox syncing, so don't set it unless you need
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	363 it. Also you shouldn't try to access it before mailbox_save_finish() is
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	364 called.
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	365
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	366 The given input stream is never read in these functions, only the data
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	367 inside it is used. So you should call i_stream_read() yourself and then
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	368 call mailbox_save_continue() whenever more data is read.
7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	369 */
4044 da1d65e064f8 mailbox_save_init() supports now returning failure. Quota plugin now checks Timo Sirainen <timo.sirainen@movial.fi> parents: 4041 diff changeset	370 int mailbox_save_init(struct mailbox_transaction_context *t,
da1d65e064f8 mailbox_save_init() supports now returning failure. Quota plugin now checks Timo Sirainen <timo.sirainen@movial.fi> parents: 4041 diff changeset	371 enum mail_flags flags, struct mail_keywords *keywords,
da1d65e064f8 mailbox_save_init() supports now returning failure. Quota plugin now checks Timo Sirainen <timo.sirainen@movial.fi> parents: 4041 diff changeset	372 time_t received_date, int timezone_offset,
da1d65e064f8 mailbox_save_init() supports now returning failure. Quota plugin now checks Timo Sirainen <timo.sirainen@movial.fi> parents: 4041 diff changeset	373 const char from_envelope, struct istream input,
4268 7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	374 struct mail dest_mail, struct mail_save_context *ctx_r);
2446 47e1e05cede0 Changed mail saving API to be nonblocking. Timo Sirainen <tss@iki.fi> parents: 2422 diff changeset	375 int mailbox_save_continue(struct mail_save_context *ctx);
4268 7112aad504ae Changed mailbox_save_() API a bit: Moved the struct mail dest_mail to Timo Sirainen <timo.sirainen@movial.fi> parents: 4152 diff changeset	376 int mailbox_save_finish(struct mail_save_context **ctx);
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	377 void mailbox_save_cancel(struct mail_save_context **ctx);
2446 47e1e05cede0 Changed mail saving API to be nonblocking. Timo Sirainen <tss@iki.fi> parents: 2422 diff changeset	378
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	379 /* Copy given message. If dest_mail is non-NULL, the copied message can be
2190 755ec9442a58 mailbox_save() and mailbox_copy() functions can now return the saved mail so Timo Sirainen <tss@iki.fi> parents: 2062 diff changeset	380 accessed using it. Note that setting it non-NULL may require mailbox
755ec9442a58 mailbox_save() and mailbox_copy() functions can now return the saved mail so Timo Sirainen <tss@iki.fi> parents: 2062 diff changeset	381 syncing, so don't give give it unless you need it. */
755ec9442a58 mailbox_save() and mailbox_copy() functions can now return the saved mail so Timo Sirainen <tss@iki.fi> parents: 2062 diff changeset	382 int mailbox_copy(struct mailbox_transaction_context t, struct mail mail,
3641 3de464cb604f Added flags and keywords parameters to mailbox_copy() in case they're wanted Timo Sirainen <tss@iki.fi> parents: 3628 diff changeset	383 enum mail_flags flags, struct mail_keywords *keywords,
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	384 struct mail *dest_mail);
1640 db14aa8e2b5c API change for expunging messages. Not exactly what I wanted, but good Timo Sirainen <tss@iki.fi> parents: 1639 diff changeset	385
1915 79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	386 /* Returns TRUE if mailbox is now in inconsistent state, meaning that
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	387 the message IDs etc. may have changed - only way to recover this
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	388 would be to fully close the mailbox and reopen it. With IMAP
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	389 connection this would mean a forced disconnection since we can't
79790750c349 importing new index code. mbox still broken. Timo Sirainen <tss@iki.fi> parents: 1845 diff changeset	390 do forced CLOSE. */
3863 55df57c028d4 Added "bool" type and changed all ints that were used as booleans to bool. Timo Sirainen <tss@iki.fi> parents: 3641 diff changeset	391 bool mailbox_is_inconsistent(struct mailbox *box);
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	392
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	393 /* Returns message's flags */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	394 enum mail_flags mail_get_flags(struct mail *mail);
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	395 /* Returns message's keywords */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	396 const char const mail_get_keywords(struct mail *mail);
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	397 /* Returns message's MIME parts */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	398 const struct message_part mail_get_parts(struct mail mail);
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	399
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	400 struct mail mail_alloc(struct mailbox_transaction_context t,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	401 enum mail_fetch_field wanted_fields,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	402 struct mailbox_header_lookup_ctx *wanted_headers);
3879 928229f8b3e6 deinit, unref, destroy, close, free, etc. functions now take a pointer to Timo Sirainen <tss@iki.fi> parents: 3863 diff changeset	403 void mail_free(struct mail **mail);
6277 5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	404 void mail_set_seq(struct mail *mail, uint32_t seq);
5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	405 /* Returns TRUE if successful, FALSE if message doesn't exist.
5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	406 mail_() functions shouldn't be called if FALSE is returned. /
5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	407 bool mail_set_uid(struct mail *mail, uint32_t uid);
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	408
4455 fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	409 /* Get the Date-header of the mail. Timezone is in minutes.
3520 e2fe8222449d s/occured/occurred/ Timo Sirainen <tss@iki.fi> parents: 3517 diff changeset	410 Returns (time_t)-1 if error occurred, 0 if field wasn't found or
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	411 couldn't be parsed. */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	412 time_t mail_get_date(struct mail mail, int timezone);
4455 fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	413 /* Get the time when the mail was received (IMAP INTERNALDATE).
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	414 Returns (time_t)-1 if error occurred. */
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	415 time_t mail_get_received_date(struct mail *mail);
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	416 /* Get the time when the mail was saved into this mailbox. This time may not
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	417 always be entirely reliable. Returns (time_t)-1 if error occurred. */
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	418 time_t mail_get_save_date(struct mail *mail);
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	419
4455 fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	420 /* Get the space used by the mail as seen by the reader. Linefeeds are always
fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	421 counted as being CR+LF. Returns (uoff_t)-1 if error occurred */
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	422 uoff_t mail_get_virtual_size(struct mail *mail);
4455 fce5140fbe0b Added mail_get_save_date() and some cleanups. Timo Sirainen <timo.sirainen@movial.fi> parents: 4451 diff changeset	423 /* Get the space used by the mail in disk.
3520 e2fe8222449d s/occured/occurred/ Timo Sirainen <tss@iki.fi> parents: 3517 diff changeset	424 Returns (uoff_t)-1 if error occurred */
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	425 uoff_t mail_get_physical_size(struct mail *mail);
988 8028c4dcf38f mail-storage.h interface changes, affects pretty much everything. Timo Sirainen <tss@iki.fi> parents: 953 diff changeset	426
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	427 /* Get value for single header field */
3248 ff47e78ad717 Renamed mail_get_header() to mail_get_first_header() and mail_gets_headers() Timo Sirainen <tss@iki.fi> parents: 3245 diff changeset	428 const char mail_get_first_header(struct mail mail, const char *field);
6120 00d1a94a94c6 Added mail_get_first_header_utf8() and mail_get_headers_utf8(). Timo Sirainen <tss@iki.fi> parents: 6023 diff changeset	429 /* Like mail_get_first_header(), but decode MIME encoded words to UTF-8 */
00d1a94a94c6 Added mail_get_first_header_utf8() and mail_get_headers_utf8(). Timo Sirainen <tss@iki.fi> parents: 6023 diff changeset	430 const char mail_get_first_header_utf8(struct mail mail, const char *field);
3248 ff47e78ad717 Renamed mail_get_header() to mail_get_first_header() and mail_gets_headers() Timo Sirainen <tss@iki.fi> parents: 3245 diff changeset	431 /* Return a NULL-terminated list of values for each found field. */
ff47e78ad717 Renamed mail_get_header() to mail_get_first_header() and mail_gets_headers() Timo Sirainen <tss@iki.fi> parents: 3245 diff changeset	432 const char const mail_get_headers(struct mail mail, const char field);
6120 00d1a94a94c6 Added mail_get_first_header_utf8() and mail_get_headers_utf8(). Timo Sirainen <tss@iki.fi> parents: 6023 diff changeset	433 /* Like mail_get_headers(), but decode MIME encoded words to UTF-8 */
00d1a94a94c6 Added mail_get_first_header_utf8() and mail_get_headers_utf8(). Timo Sirainen <tss@iki.fi> parents: 6023 diff changeset	434 const char const mail_get_headers_utf8(struct mail mail, const char field);
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	435 /* Returns stream containing specified headers. */
3248 ff47e78ad717 Renamed mail_get_header() to mail_get_first_header() and mail_gets_headers() Timo Sirainen <tss@iki.fi> parents: 3245 diff changeset	436 struct istream *
ff47e78ad717 Renamed mail_get_header() to mail_get_first_header() and mail_gets_headers() Timo Sirainen <tss@iki.fi> parents: 3245 diff changeset	437 mail_get_header_stream(struct mail *mail,
ff47e78ad717 Renamed mail_get_header() to mail_get_first_header() and mail_gets_headers() Timo Sirainen <tss@iki.fi> parents: 3245 diff changeset	438 struct mailbox_header_lookup_ctx *headers);
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	439 /* Returns input stream pointing to beginning of message header.
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	440 hdr_size and body_size are updated unless they're NULL. */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	441 struct istream mail_get_stream(struct mail mail,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	442 struct message_size *hdr_size,
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	443 struct message_size *body_size);
1637 a64391b49589 API change for copying messages. Timo Sirainen <tss@iki.fi> parents: 1622 diff changeset	444
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	445 /* Get any of the "special" fields. */
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	446 const char mail_get_special(struct mail mail, enum mail_fetch_field field);
1638 e95c0e462591 API change for updating message flags. Timo Sirainen <tss@iki.fi> parents: 1637 diff changeset	447
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	448 /* Update message flags. */
6277 5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	449 void mail_update_flags(struct mail *mail, enum modify_type modify_type,
5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	450 enum mail_flags flags);
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	451 /* Update message keywords. */
6277 5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	452 void mail_update_keywords(struct mail *mail, enum modify_type modify_type,
5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	453 struct mail_keywords *keywords);
3209 923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	454
923ff19873d4 Major mail-storage API changes. It's now a bit cleaner and much more plugin Timo Sirainen <tss@iki.fi> parents: 3207 diff changeset	455 /* Expunge this message. Sequence numbers don't change until commit. */
6277 5f66277bbe40 mail_index_lookup() can't fail anymore. Changed several APIs not to return Timo Sirainen <tss@iki.fi>* parents: 6275 diff changeset	456 void mail_expunge(struct mail *mail);
450 925d6eb5f8be MailStorage interface change. We now let storage call several sync-functions Timo Sirainen <tss@iki.fi> parents: 410 diff changeset	457
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	458 #endif

Mercurial > dovecot > original-hg > dovecot-1.2

annotate src/lib-storage/mail-storage.h @ 6279:f52e7d1402b5 HEAD