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
21 * supported mailbox formats
22 * in mx_init() the registration order must be exactly as given here!!!1!
57 /* ugly hack to define macro once (for pager+index) */
58 #define CHECK_MX_ACL(c,f,s) if(!mx_acl_check(c,f)) \
61 mutt_error(_("%s not permitted by ACL."), s); \
68 /* may we stat() it? */
69 unsigned int local : 1;
70 /* tests if given path is of its magic */
71 int (*mx_is_magic) (const char*);
72 /* tests if folder is empty */
73 int (*mx_check_empty) (const char*);
75 int (*mx_access) (const char*, int);
76 /* read mailbox into ctx structure */
77 int (*mx_open_mailbox) (CONTEXT*);
78 /* check ACL flags; if not implemented, always assume granted
80 int (*mx_acl_check) (CONTEXT*, int);
83 /* called from main: init all folder types */
86 /* flags for mx_open_mailbox() */
87 #define M_NOSORT (1<<0) /* do not sort the mailbox after opening it */
88 #define M_APPEND (1<<1) /* open mailbox for appending messages */
89 #define M_READONLY (1<<2) /* open in read-only mode */
90 #define M_QUIET (1<<3) /* do not print any messages */
91 #define M_NEWFOLDER (1<<4) /* create a new folder - same as M_APPEND, but uses
92 * safe_fopen() for mbox-style folders.
95 /* mx_open_new_message() */
96 #define M_ADD_FROM 1 /* add a From_ line */
98 #define MAXLOCKATTEMPT 5
100 /* return values from mx_check_mailbox() */
102 M_NEW_MAIL = 1, /* new mail received in mailbox */
103 M_LOCKED, /* couldn't lock the mailbox */
104 M_REOPENED, /* mailbox was reopened */
105 M_FLAGS /* nondestructive flags change (IMAP) */
109 FILE *fp; /* pointer to the message data */
110 char *path; /* path to temp file */
111 short magic; /* type of mailbox this message belongs to */
112 short write; /* nonzero if message is open for writing */
118 time_t received; /* the time at which this message was received */
121 WHERE short DefaultMagic INITVAL (M_MBOX);
124 * please use the following _ONLY_ when doing "something"
128 CONTEXT *mx_open_mailbox (const char *, int, CONTEXT *);
130 MESSAGE *mx_open_message (CONTEXT *, int);
131 MESSAGE *mx_open_new_message (CONTEXT *, HEADER *, int);
133 void mx_fastclose_mailbox (CONTEXT *);
135 int mx_close_mailbox (CONTEXT *, int *);
136 int mx_sync_mailbox (CONTEXT *, int *);
137 int mx_commit_message (MESSAGE *, CONTEXT *);
138 int mx_close_message (MESSAGE **);
139 int mx_get_magic (const char *);
140 int mx_set_magic (const char *);
141 int mx_check_mailbox (CONTEXT *, int *, int);
143 int mx_access (const char *, int);
144 int mx_check_empty (const char *);
146 int mx_acl_check (CONTEXT*, int);
148 void mx_alloc_memory (CONTEXT *);
149 void mx_update_context (CONTEXT *, int);
150 void mx_update_tables (CONTEXT *, int);
152 int mx_lock_file (const char *, int, int, int, int);
153 int mx_unlock_file (const char *path, int fd, int dot);