mbox.h 3.69 KB
/* GNU Mailutils -- a suite of utilities for electronic mail
   Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA  */

#ifndef _MAILUTILS_MBOX_H
#define _MAILUTILS_MBOX_H

#include <mailutils/mu_features.h>
#include <mailutils/types.h>
#include <mailutils/stream.h>
#include <mailutils/attribute.h>
#include <mailutils/debug.h>

#ifdef __cplusplus
extern "C" {
#endif

extern int  mbox_create __P ((mbox_t *));
extern void mbox_destroy __P ((mbox_t *));

extern int  mbox_get_uidvalidity __P ((mbox_t, unsigned long *));
extern int  mbox_get_uidnext     __P ((mbox_t, unsigned long *));

extern int  mbox_open            __P ((mbox_t, const char *, int));
extern int  mbox_close           __P ((mbox_t));

extern int  mbox_get_hstream     __P ((mbox_t, unsigned int, stream_t *));
extern int  mbox_set_hstream     __P ((mbox_t, unsigned int, stream_t));
extern int  mbox_get_hsize       __P ((mbox_t, unsigned int, unsigned int *));
extern int  mbox_get_hlines      __P ((mbox_t, unsigned int, unsigned int *));

extern int  mbox_get_bstream     __P ((mbox_t, unsigned int, stream_t *));
extern int  mbox_set_bstream     __P ((mbox_t, unsigned int, stream_t));
extern int  mbox_get_bsize       __P ((mbox_t, unsigned int, unsigned int *));
extern int  mbox_get_blines      __P ((mbox_t, unsigned int, unsigned int *));

extern int  mbox_get_attribute   __P ((mbox_t, unsigned int, attribute_t *));
extern int  mbox_get_uid         __P ((mbox_t, unsigned int, unsigned long *));
extern int  mbox_get_size        __P ((mbox_t, off_t *));
extern int  mbox_get_separator   __P ((mbox_t, unsigned int, char **));
extern int  mbox_set_separator   __P ((mbox_t, unsigned int, const char *));

extern int  mbox_expunge         __P ((mbox_t));
extern int  mbox_save            __P ((mbox_t));
extern int  mbox_has_newmail     __P ((mbox_t));

extern int  mbox_set_progress_cb __P ((mbox_t,
				       int (*) __P ((int, void *)), void *));
extern int  mbox_set_newmsg_cb   __P ((mbox_t,
				       int (*) __P ((int, void *)), void *));
extern int  mbox_set_error_cb    __P ((mbox_t,
				       int (*) __P ((int, void *)), void *));

extern int  mbox_scan            __P ((mbox_t, unsigned int, unsigned int *));
extern int  mbox_count  __P ((mbox_t, unsigned int *));

extern int  mbox_append          __P ((mbox_t, const char *, attribute_t,
				       stream_t));
extern int  mbox_append_hb       __P ((mbox_t, const char *, attribute_t,
				       stream_t, stream_t));

extern int  mbox_get_carrier     __P ((mbox_t, stream_t *));
extern int  mbox_set_carrier     __P ((mbox_t, stream_t));

extern int  mbox_set_hcache      __P ((mbox_t, const char **, size_t));
extern int  mbox_add_hcache      __P ((mbox_t, const char **, size_t));

extern int  mbox_value_hcache    __P ((mbox_t, unsigned int, const char *,
				       char *, size_t, size_t *));

extern int  mbox_get_debug        __P ((mbox_t, mu_debug_t *));
extern int  mbox_set_debug        __P ((mbox_t, mu_debug_t));


#ifdef __cplusplus
}
#endif

#endif /* _MAILUTILS_MBOX_H */