summaryrefslogtreecommitdiff
path: root/doc/texinfo/folder.texi
blob: 557dfd3a6f03d82785b840b24b80aac026a4cc8d (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
@c This is part of the GNU Mailutils manual.
@c Copyright (C) 1999-2004, 2006-2007, 2010-2012, 2014-2017 Free
@c Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************

@smallexample
@code{/* Prefix @emph{mu_folder_} is reserved. */}
@code{#include <mailutils/folder.h>}

@end smallexample

@smallexample
@group
                             mu_folder_t                mu_url_t
  -/var/mail-    +---//--->/-------------------\   +-->/-----------\
 (  alain *-)-+  |         |  mu_url_t       *-|---+   |  port     |
  ----------  |  |         |-------------------+       |  hostname |
 (  jakob *-)-+--+         |  mu_observer_t  *-|       |  file     |
  ----------  |            |-------------------+       |  ...      |
 (  jeff  *-)-+            |  mu_stream_t      |       \-----------/
  ----------  |            |-------------------|
 (  sean  *-)-+            |  mu_auth_t        |
  ----------               |-------------------|
                           |  mu_mailbox_t(1)  |
                           |-------------------|
                           |  mu_mailbox_t(2)  |
                           |  ......           |
                           |  mu_mailbox_t(n)  |
                           \-----------------/
@end group
@end smallexample

Data structures:

@smallexample
@group
struct mu_list_response
@{
  int type;
  int separator;
  char *name;
@};

@end group
@end smallexample

@c
@c Constructor/Destructor and possible types.
@c

@deftypefun  int mu_folder_create (mu_folder_t *, const char *@var{url})
@end deftypefun

@deftypefun void mu_folder_destroy (mu_folder_t *)
@end deftypefun

@deftypefun  int mu_folder_open (mu_folder_t, int @var{flag})
@end deftypefun

@deftypefun  int mu_folder_close (mu_folder_t)
@end deftypefun

@deftypefun  int mu_folder_delete (mu_folder_t, const char *@var{mailbox})
@end deftypefun

@deftypefun  int mu_folder_rename (mu_folder_t, const char *, const char *@var{mailbox})
@end deftypefun

@deftypefun  int mu_folder_subscribe (mu_folder_t, const char *@var{mailbox})
@end deftypefun

@deftypefun  int mu_folder_unsubscribe (mu_folder_t, const char *@var{mailbox})
@end deftypefun

@deftypefun  int mu_folder_list (mu_folder_t, const char *@var{ref}, const char *@var{wcard}, size_t @var{size}, mu_list_t *@var{list})
@end deftypefun

@deftypefun  int mu_folder_lsub (mu_folder_t, const char *@var{ref}, const char *@var{wcard}, mu_list_t *@var{list})
@end deftypefun

@c
@c Stream Settings.
@c

@c
@c Notifications.
@c

@deftypefun  int mu_folder_get_observable (mu_folder_t, mu_observable_t *)
@end deftypefun

@c
@c Debug.
@c

@deftypefun  int mu_folder_has_debug (mu_folder_t)
@end deftypefun

@deftypefun  int mu_folder_get_debug (mu_folder_t, mu_debug_t *)
@end deftypefun

@deftypefun  int mu_folder_set_debug (mu_folder_t, mu_debug_t)
@end deftypefun

@c
@c Authentication.
@c

@deftypefun  int mu_folder_get_authority (mu_folder_t, mu_authority_t *)
@end deftypefun

@deftypefun  int mu_folder_set_authority (mu_folder_t, mu_authority_t)
@end deftypefun

@c
@c URL.
@c

@deftypefun  int mu_folder_get_url (mu_folder_t, mu_url_t *)
@end deftypefun

@deftypefun  int mu_folder_set_url (mu_folder_t, mu_url_t)
@end deftypefun

Return to:

Send suggestions and report system problems to the System administrator.