summaryrefslogtreecommitdiff
path: root/include/mailutils/mailbox.h
blob: 244accdbb4bb05e919a26d1557268462c3c372d7 (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
/* GNU Mailutils -- a suite of utilities for electronic mail
   Copyright (C) 1999, 2000, 2001, 2005  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., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301 USA */

#ifndef _MAILUTILS_MAILBOX_H
#define _MAILUTILS_MAILBOX_H

#include <sys/types.h>

#include <mailutils/types.h>

#ifdef __cplusplus
extern "C" {
#endif

int mu_set_mail_directory (const char *p);
void mu_set_folder_directory (const char *p);
const char *mu_mail_directory (void);
const char *mu_folder_directory (void);
int mu_construct_user_mailbox_url (char **pout, const char *name);
  
/* Constructor/destructor and possible types.  */
extern int  mailbox_create          (mailbox_t *, const char *);
extern void mailbox_destroy         (mailbox_t *);
extern int  mailbox_create_default  (mailbox_t *, const char *);

extern int  mailbox_open            (mailbox_t, int flag);
extern int  mailbox_close           (mailbox_t);
extern int  mailbox_flush           (mailbox_t mbox, int expunge);
extern int  mailbox_get_folder      (mailbox_t, folder_t *);
extern int  mailbox_set_folder      (mailbox_t, folder_t);
extern int  mailbox_uidvalidity     (mailbox_t, unsigned long *);
extern int  mailbox_uidnext         (mailbox_t, size_t *);

/* Messages.  */
extern int  mailbox_get_message     (mailbox_t, size_t msgno, message_t *);
extern int  mailbox_append_message  (mailbox_t, message_t);
extern int  mailbox_messages_count  (mailbox_t, size_t *);
extern int  mailbox_messages_recent (mailbox_t, size_t *);
extern int  mailbox_message_unseen  (mailbox_t, size_t *);
extern int  mailbox_expunge         (mailbox_t);
extern int  mailbox_save_attributes (mailbox_t);

/* Update and scanning.  */
extern int  mailbox_get_size        (mailbox_t, off_t *size);
extern int  mailbox_is_updated      (mailbox_t);
extern int  mailbox_scan            (mailbox_t, size_t no, size_t *count);

/* Mailbox Stream.  */
extern int  mailbox_set_stream      (mailbox_t, stream_t);
extern int  mailbox_get_stream      (mailbox_t, stream_t *);

/* Lock settings.  */
extern int  mailbox_get_locker      (mailbox_t, locker_t *);
extern int  mailbox_set_locker      (mailbox_t, locker_t);

/* Property.  */
extern int  mailbox_get_flags       (mailbox_t, int *);
extern int  mailbox_get_property    (mailbox_t, property_t *);

/* URL.  */
extern int  mailbox_get_url         (mailbox_t, url_t *);

/* For any debuging */
extern int  mailbox_has_debug       (mailbox_t);
extern int  mailbox_get_debug       (mailbox_t, mu_debug_t *);
extern int  mailbox_set_debug       (mailbox_t, mu_debug_t);

/* Events.  */
extern int  mailbox_get_observable  (mailbox_t, observable_t *);

/* Locking */  
extern int mailbox_lock (mailbox_t mbox);
extern int mailbox_unlock (mailbox_t mbox);
  
#ifdef __cplusplus
}
#endif

#endif /* _MAILUTILS_MAILBOX_H */

Return to:

Send suggestions and report system problems to the System administrator.