mailbox0.h 3.52 KB
/* GNU mailutils - a suite of utilities for electronic mail
   Copyright (C) 1999, 2000 Free Software Foundation, Inc.

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

   This program 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 Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */

#ifndef _MAILBOX0_H
#define _MAILBOX0_H

#include <mailbox.h>

#include <sys/types.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef __P
# ifdef __STDC__
#  define __P(args) args
# else
#  define __P(args) ()
# endif
#endif /*__P */

struct _mailbox
{
  /* Data */

  char *name;
  FILE *file;
  message_t *messages;
  size_t messages_num;
  off_t size;

  auth_t auth;
  locker_t locker;
  url_t url;

  int  (*_progress)  __P ((int, void *arg));
  void *progress_arg;

  /* Back pointer to the specific mailbox */
  void *data;

  /* Public methods */

  int  (*_init)            __P ((mailbox_t *, const char *));
  void (*_destroy)         __P ((mailbox_t *));

  int  (*_open)            __P ((mailbox_t, int flag));
  int  (*_close)           __P ((mailbox_t));

  /* messages */
  int  (*_get_message)     __P ((mailbox_t, size_t msgno, message_t *msg));
  int  (*_append_message)  __P ((mailbox_t, message_t msg));
  int  (*_messages_count)  __P ((mailbox_t, size_t *num));
  int  (*_expunge)         __P ((mailbox_t));

  int  (*_is_updated)      __P ((mailbox_t));

  int  (*_size)            __P ((mailbox_t, off_t *size));

  /* private */
  int  (*_delete)          __P ((mailbox_t, size_t msgno));
  int  (*_undelete)        __P ((mailbox_t, size_t msgno));
  int  (*_is_deleted)      __P ((mailbox_t, size_t msgno));
  int  (*_num_deleted)     __P ((mailbox_t, size_t *));
  int  (*_get_size)        __P ((mailbox_t, size_t msgno,
				 size_t *h, size_t *b));

  ssize_t  (*_get_header)  __P ((mailbox_t, size_t msgno, char *h,
				 size_t len, off_t off, int *err));
  ssize_t  (*_get_body)    __P ((mailbox_t, size_t msgno, char *b,
				 size_t len, off_t off, int *err));
};

/* private */
extern int mailbox_delete         __P ((mailbox_t, size_t msgno));
extern int mailbox_undelete       __P ((mailbox_t, size_t msgno));
extern int mailbox_is_deleted     __P ((mailbox_t, size_t msgno));
extern int mailbox_num_deleted    __P ((mailbox_t, size_t *));
extern int mailbox_get_size       __P ((mailbox_t, size_t msgno,
					size_t *h, size_t *b));
extern ssize_t mailbox_get_header __P ((mailbox_t, size_t msgno, char *h,
					size_t len, off_t off, int *err));
extern ssize_t mailbox_get_body   __P ((mailbox_t, size_t msgno, char *b,
					size_t len, off_t off, int *err));

extern int mailbox_get_auth       __P ((mailbox_t mbox, auth_t *auth));
extern int mailbox_set_auth       __P ((mailbox_t mbox, auth_t auth));
extern int mailbox_get_locker     __P ((mailbox_t mbox, locker_t *locker));
extern int mailbox_set_locker     __P ((mailbox_t mbox, locker_t locker));
extern int mailbox_progress       __P ((mailbox_t mbox,
					int (*progress) (int, void *arg),
					void *arg));


#ifdef __cplusplus
}
#endif

#endif /* _MAILBOX0_H */