summaryrefslogtreecommitdiff
path: root/include/mailutils/folder.h
blob: 3870f32d9c5f9eb865d76cbf5b4d23f2dd83fee9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/* GNU mailutils - a suite of utilities for electronic mail
   Copyright (C) 1999, 2000, 2001 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 _MAILUTILS_FOLDER_H
# define _MAILUTILS_FOLDER_H

#include <sys/types.h>

#include <mailutils/mu_features.h>
#include <mailutils/url.h>
#include <mailutils/observer.h>
#include <mailutils/debug.h>
#include <mailutils/stream.h>
#include <mailutils/auth.h>
#include <mailutils/stream.h>


#ifdef __cplusplus
extern "C" {
#endif

/* Forward declaration.  */
struct _folder;
typedef struct _folder *folder_t;

#define MU_FOLDER_ATTRIBUTE_DIRECTORY 0x001
#define MU_FOLDER_ATTRIBUTE_FILE      0x002
struct list_response
{
  int type;
  int separator;
  char *name;
};

struct folder_list
{
  struct list_response **element;
  size_t num;
};

/* Constructor/destructor and possible types.  */
extern int  folder_create         __P ((folder_t *, const char *));
extern void folder_destroy        __P ((folder_t *));

extern int  folder_open           __P ((folder_t, int flag));
extern int  folder_close          __P ((folder_t));

extern int  folder_delete         __P ((folder_t, const char *));
extern int  folder_rename         __P ((folder_t, const char *, const char *));
extern int  folder_subscribe      __P ((folder_t, const char *));
extern int  folder_unsubscribe    __P ((folder_t, const char *));
extern int  folder_list           __P ((folder_t, const char *, const char *,
				       struct folder_list *));
extern int  folder_lsub           __P ((folder_t, const char *, const char *,
				       struct folder_list *));
extern int  folder_list_destroy   __P ((struct folder_list *));

/* Stream settings.  */
extern int  folder_get_stream     __P ((folder_t, stream_t *));
extern int  folder_set_stream     __P ((folder_t, stream_t));

  /* Notifications.  */
extern int  folder_get_observable __P ((folder_t, observable_t *));

  /* Debug.  */
extern int  folder_has_debug      __P ((folder_t folder));
extern int  folder_get_debug      __P ((folder_t, mu_debug_t *));
extern int  folder_set_debug      __P ((folder_t, mu_debug_t));

/* Authentication.  */
extern int  folder_get_authority  __P ((folder_t, authority_t *));
extern int  folder_set_authority  __P ((folder_t, authority_t));

/* URL.  */
extern int  folder_get_url        __P ((folder_t, url_t *));
extern int  folder_set_url        __P ((folder_t, url_t));

/* FIXME: not implemented */
extern int  folder_decrement      __P ((folder_t));


#ifdef __cplusplus
}
#endif

#endif /* _MAILUTILS_FOLDER_H */

Return to:

Send suggestions and report system problems to the System administrator.