mx.h

   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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 #ifdef USE_IMAP
  38   , M_IMAP
  39 #endif
  40 #ifdef USE_POP
  41   , M_POP
  42 #endif
  43 #ifdef USE_NNTP
  44   , M_NNTP
  45 #endif
  46 #ifdef USE_COMPRESSED
  47   , M_COMPRESSED
  48 #endif
  49 };
  50
  51 WHERE short DefaultMagic INITVAL (M_MBOX);
  52
  53 #define MMDF_SEP "\001\001\001\001\n"
  54 #define MAXLOCKATTEMPT 5
  55
  56 int mbox_sync_mailbox (CONTEXT *, int *);
  57 int mbox_open_mailbox (CONTEXT *);
  58 int mbox_check_mailbox (CONTEXT *, int *);
  59 int mbox_close_mailbox (CONTEXT *);
  60 int mbox_lock_mailbox (CONTEXT *, int, int);
  61 int mbox_parse_mailbox (CONTEXT *);
  62 int mmdf_parse_mailbox (CONTEXT *);
  63 void mbox_unlock_mailbox (CONTEXT *);
  64 int mbox_check_empty (const char *);
  65
  66 int mh_read_dir (CONTEXT *, const char *);
  67 int mh_sync_mailbox (CONTEXT *, int *);
  68 int mh_check_mailbox (CONTEXT *, int *);
  69 int mh_buffy (const char *);
  70 int mh_check_empty (const char *);
  71
  72 int maildir_read_dir (CONTEXT *);
  73 int maildir_check_mailbox (CONTEXT *, int *);
  74 int maildir_check_empty (const char *);
  75
  76 int maildir_commit_message (CONTEXT *, MESSAGE *, HEADER *);
  77 int mh_commit_message (CONTEXT *, MESSAGE *, HEADER *);
  78
  79 int maildir_open_new_message (MESSAGE *, CONTEXT *, HEADER *);
  80 int mh_open_new_message (MESSAGE *, CONTEXT *, HEADER *);
  81
  82 FILE *maildir_open_find_message (const char *, const char *);
  83
  84 int mbox_strict_cmp_headers (const HEADER *, const HEADER *);
  85 int mutt_reopen_mailbox (CONTEXT *, int *);
  86
  87 void mx_alloc_memory (CONTEXT *);
  88 void mx_update_context (CONTEXT *, int);
  89 void mx_update_tables (CONTEXT *, int);
  90
  91
  92 int mx_lock_file (const char *, int, int, int, int);
  93 int mx_unlock_file (const char *path, int fd, int dot);
  94
  95
  96 #endif