folder.h
3.53 KB
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
/* GNU Mailutils -- a suite of utilities for electronic mail
Copyright (C) 1999-2001, 2005, 2007, 2009-2012, 2014-2016 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 3 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, see
<http://www.gnu.org/licenses/>. */
#ifndef _MAILUTILS_FOLDER_H
# define _MAILUTILS_FOLDER_H
#include <mailutils/types.h>
#ifdef __cplusplus
extern "C" {
#endif
struct mu_list_response
{
int type; /* MU_FOLDER_ATTRIBUTE_.* flags */
int level;
int separator;
char *name;
mu_record_t format; /* Associated mailbox format record */
};
typedef int (*mu_folder_match_fp) (const char *, void *, int);
typedef int (*mu_folder_enumerate_fp) (mu_folder_t, struct mu_list_response *,
void *data);
/* Constructor/destructor and possible types. */
extern int mu_folder_create (mu_folder_t *, const char *);
extern int mu_folder_create_from_record (mu_folder_t *, mu_url_t url,
mu_record_t);
extern void mu_folder_destroy (mu_folder_t *);
extern int mu_folder_open (mu_folder_t, int flag);
extern int mu_folder_close (mu_folder_t);
extern int mu_folder_delete (mu_folder_t, const char *);
extern int mu_folder_rename (mu_folder_t, const char *, const char *);
extern int mu_folder_subscribe (mu_folder_t, const char *);
extern int mu_folder_unsubscribe (mu_folder_t, const char *);
extern int mu_folder_list (mu_folder_t, const char *, void *,
size_t, mu_list_t *);
extern int mu_folder_enumerate (mu_folder_t, const char *,
void *, int,
size_t, mu_list_t *,
mu_folder_enumerate_fp, void *);
extern int mu_folder_lsub (mu_folder_t, const char *, const char *,
mu_list_t *);
/* Match function */
extern int mu_folder_set_match (mu_folder_t folder, mu_folder_match_fp pmatch);
extern int mu_folder_get_match (mu_folder_t folder,
mu_folder_match_fp *pmatch);
/* Two often used matchers: */
/* 1. The default: IMAP-style wildcards: */
extern int mu_folder_imap_match (const char *name, void *pattern, int flags);
/* 2. UNIX-style glob(7) wildcards: */
extern int mu_folder_glob_match (const char *name, void *pattern, int flags);
/* Notifications. */
extern int mu_folder_get_observable (mu_folder_t, mu_observable_t *);
/* Authentication. */
extern int mu_folder_get_authority (mu_folder_t, mu_authority_t *);
extern int mu_folder_set_authority (mu_folder_t, mu_authority_t);
/* URL. */
extern int mu_folder_get_url (mu_folder_t, mu_url_t *);
extern int mu_folder_set_url (mu_folder_t, mu_url_t);
/* Property */
extern int mu_folder_set_property (mu_folder_t, mu_property_t);
extern int mu_folder_get_property (mu_folder_t, mu_property_t *);
/* FIXME: not implemented */
extern int mu_folder_decrement (mu_folder_t);
extern void mu_list_response_free (void *data);
int _mu_fsfolder_init (mu_folder_t folder);
#ifdef __cplusplus
}
#endif
#endif /* _MAILUTILS_FOLDER_H */