2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 1999-2002 Thomas Roessler <roessler@does-not-exist.org>
6 * This file is part of mutt-ng, see http://www.muttng.org/.
7 * It's licensed under the GNU General Public License,
8 * please see the file GPL in the top level source directory.
13 * when adding code dealing with folders or whatever,
14 * please use these only
24 * supported mailbox formats
25 * in mx_init() the registration order must be exactly as given here!!!1!
60 /* ugly hack to define macro once (for pager+index) */
61 #define CHECK_MX_ACL(c,f,s) if(!mx_acl_check(c,f)) \
64 mutt_error(_("%s not permitted by ACL."), s); \
69 FILE *fp; /* pointer to the message data */
70 char *path; /* path to temp file */
71 short magic; /* type of mailbox this message belongs to */
72 short write; /* nonzero if message is open for writing */
78 time_t received; /* the time at which this message was received */
84 /* may we stat() it? */
85 unsigned int local : 1;
86 /* tests if given path is of its magic */
87 int (*mx_is_magic) (const char*, struct stat*);
88 /* tests if folder is empty */
89 int (*mx_check_empty) (const char*);
91 int (*mx_access) (const char*, int);
92 /* read mailbox into ctx structure */
93 int (*mx_open_mailbox) (CONTEXT*);
94 /* open new message */
95 int (*mx_open_new_message) (MESSAGE*, CONTEXT*, HEADER*);
96 /* check ACL flags; if not implemented, always assume granted
98 int (*mx_acl_check) (CONTEXT*, int);
99 /* check for new mail; see mx_check_mailbox() below for return vals */
100 int (*mx_check_mailbox) (CONTEXT*, int*, int);
102 void (*mx_fastclose_mailbox) (CONTEXT*);
103 /* write out changes */
104 int (*mx_sync_mailbox) (CONTEXT*, int, int*);
105 /* commit a message to a folder */
106 int (*mx_commit_message) (MESSAGE*, CONTEXT*);
109 /* called from main: init all folder types */
112 /* flags for mx_open_mailbox() */
113 #define M_NOSORT (1<<0) /* do not sort the mailbox after opening it */
114 #define M_APPEND (1<<1) /* open mailbox for appending messages */
115 #define M_READONLY (1<<2) /* open in read-only mode */
116 #define M_QUIET (1<<3) /* do not print any messages */
117 #define M_NEWFOLDER (1<<4) /* create a new folder - same as M_APPEND, but uses
118 * safe_fopen() for mbox-style folders. */
119 #define M_COUNT (1<<5) /* just do counting? needed to do speed optimizations
122 /* mx_open_new_message() */
123 #define M_ADD_FROM 1 /* add a From_ line */
125 #define MAXLOCKATTEMPT 5
127 WHERE short DefaultMagic INITVAL (M_MBOX);
130 * please use the following _ONLY_ when doing "something"
134 CONTEXT *mx_open_mailbox (const char *, int, CONTEXT *);
136 MESSAGE *mx_open_message (CONTEXT *, int);
137 MESSAGE *mx_open_new_message (CONTEXT *, HEADER *, int);
139 void mx_fastclose_mailbox (CONTEXT *);
141 int mx_close_mailbox (CONTEXT *, int *);
142 int mx_sync_mailbox (CONTEXT *, int *);
143 int mx_commit_message (MESSAGE *, CONTEXT *);
144 int mx_close_message (MESSAGE **);
146 /* determines magic for given folder */
147 int mx_get_magic (const char*);
148 /* sets/parses DefaultMagic */
149 int mx_set_magic (const char *);
150 /* tests whether given folder magic is (valid and) local */
151 int mx_is_local (int);
153 /* return values from mx_check_mailbox() */
155 M_NEW_MAIL = 1, /* new mail received in mailbox */
156 M_LOCKED, /* couldn't lock the mailbox */
157 M_REOPENED, /* mailbox was reopened */
158 M_FLAGS /* nondestructive flags change (IMAP) */
160 int mx_check_mailbox (CONTEXT *, int *, int);
162 int mx_access (const char *, int);
163 int mx_check_empty (const char *);
165 int mx_acl_check (CONTEXT*, int);
167 void mx_alloc_memory (CONTEXT *);
168 void mx_update_context (CONTEXT *, int);
169 void mx_update_tables (CONTEXT *, int);
171 int mx_lock_file (const char *, int, int, int, int);
172 int mx_unlock_file (const char *path, int fd, int dot);
174 int mx_rebuild_cache (void);