1 /*
2  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
3  * Copyright (C) 1999-2002 Thomas Roessler <roessler@does-not-exist.org>
4  *
5  *     This program is free software; you can redistribute it and/or modify
6  *     it under the terms of the GNU General Public License as published by
7  *     the Free Software Foundation; either version 2 of the License, or
8  *     (at your option) any later version.
9  *
10  *     This program is distributed in the hope that it will be useful,
11  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *     GNU General Public License for more details.
14  *
15  *     You should have received a copy of the GNU General Public License
16  *     along with this program; if not, write to the Free Software
17  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18  */
19 
20 /*
21  * This header file contains prototypes for internal functions used by the
22  * generic mailbox api.  None of these functions should be called directly.
23  */
24 
25 #ifndef _MX_H
26 #define _MX_H
27 
28 #include "mailbox.h"
29 
30 /* supported mailbox formats */
31 enum
32 {
33   M_MBOX = 1,
34   M_MMDF,
35   M_MH,
36   M_MAILDIR,
37   M_IMAP,
38   M_POP
39 };
40 
41 WHERE short DefaultMagic INITVAL (M_MBOX);
42 
43 #define MMDF_SEP "\001\001\001\001\n"
44 #define MAXLOCKATTEMPT 5
45 
46 int mbox_sync_mailbox (CONTEXT *, int *);
47 int mbox_open_mailbox (CONTEXT *);
48 int mbox_check_mailbox (CONTEXT *, int *);
49 int mbox_close_mailbox (CONTEXT *);
50 int mbox_lock_mailbox (CONTEXT *, int, int);
51 int mbox_parse_mailbox (CONTEXT *);
52 int mmdf_parse_mailbox (CONTEXT *);
53 void mbox_unlock_mailbox (CONTEXT *);
54 int mbox_check_empty (const char *);
55 void mbox_reset_atime (CONTEXT *, struct stat *);
56 
57 int mh_read_dir (CONTEXT *, const char *);
58 int mh_sync_mailbox (CONTEXT *, int *);
59 int mh_check_mailbox (CONTEXT *, int *);
60 int mh_buffy (const char *);
61 int mh_check_empty (const char *);
62 
63 int maildir_read_dir (CONTEXT *);
64 int maildir_check_mailbox (CONTEXT *, int *);
65 int maildir_check_empty (const char *);
66 
67 int maildir_commit_message (CONTEXT *, MESSAGE *, HEADER *);
68 int mh_commit_message (CONTEXT *, MESSAGE *, HEADER *);
69 
70 int maildir_open_new_message (MESSAGE *, CONTEXT *, HEADER *);
71 int mh_open_new_message (MESSAGE *, CONTEXT *, HEADER *);
72 
73 FILE *maildir_open_find_message (const char *, const char *);
74 
75 int mbox_strict_cmp_headers (const HEADER *, const HEADER *);
76 int mutt_reopen_mailbox (CONTEXT *, int *);
77 
78 void mx_alloc_memory (CONTEXT *);
79 void mx_update_context (CONTEXT *, int);
80 void mx_update_tables (CONTEXT *, int);
81 
82 
83 int mx_lock_file (const char *, int, int, int, int);
84 int mx_unlock_file (const char *path, int fd, int dot);
85 
86 
87 #endif
88