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
|
/**
* @file
* API for mailboxes
*
* @authors
* Copyright (C) 1996-2002,2013 Michael R. Elkins <me@mutt.org>
* Copyright (C) 1999-2002 Thomas Roessler <roessler@does-not-exist.org>
* Copyright (C) 2017-2018 Richard Russon <rich@flatcap.org>
*
* @copyright
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 2 of the License, 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 General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MUTT_MX_H
#define MUTT_MX_H
#include <stdbool.h>
#include <stdint.h>
#include "config/lib.h"
#include "core/lib.h"
struct Buffer;
struct Email;
extern const struct EnumDef MboxTypeDef;
typedef uint8_t MsgOpenFlags; ///< Flags for mx_msg_open_new(), e.g. #MUTT_ADD_FROM
#define MUTT_MSG_NO_FLAGS 0 ///< No flags are set
#define MUTT_ADD_FROM (1 << 0) ///< add a From_ line
#define MUTT_SET_DRAFT (1 << 1) ///< set the message draft flag
/* Wrappers for the Mailbox API, see MxOps */
enum MxStatus mx_mbox_check (struct Mailbox *m);
enum MxStatus mx_mbox_check_stats (struct Mailbox *m, uint8_t flags);
enum MxStatus mx_mbox_close (struct Mailbox *m);
bool mx_mbox_open (struct Mailbox *m, OpenMailboxFlags flags);
enum MxStatus mx_mbox_sync (struct Mailbox *m);
int mx_msg_close (struct Mailbox *m, struct Message **ptr);
int mx_msg_commit (struct Mailbox *m, struct Message *msg);
struct Message * mx_msg_open_new (struct Mailbox *m, const struct Email *e, MsgOpenFlags flags);
struct Message * mx_msg_open (struct Mailbox *m, struct Email *e);
int mx_msg_padding_size (struct Mailbox *m);
int mx_save_hcache (struct Mailbox *m, struct Email *e);
int mx_path_canon (struct Buffer *path, const char *folder, enum MailboxType *type);
int mx_path_canon2 (struct Mailbox *m, const char *folder);
int mx_path_parent (struct Buffer *path);
int mx_path_pretty (struct Buffer *path, const char *folder);
enum MailboxType mx_path_probe (const char *path);
struct Mailbox * mx_path_resolve (const char *path);
struct Mailbox * mx_resolve (const char *path_or_name);
int mx_tags_commit (struct Mailbox *m, struct Email *e, const char *tags);
int mx_tags_edit (struct Mailbox *m, const char *tags, struct Buffer *buf);
enum MailboxType mx_type (struct Mailbox *m);
struct Account * mx_ac_find (struct Mailbox *m);
struct Mailbox * mx_mbox_find (struct Account *a, const char *path);
struct Mailbox * mx_mbox_find2 (const char *path);
bool mx_mbox_ac_link (struct Mailbox *m);
bool mx_ac_add (struct Account *a, struct Mailbox *m);
int mx_ac_remove (struct Mailbox *m, bool keep_account);
int mx_access (const char *path, int flags);
void mx_alloc_memory (struct Mailbox *m, int req_size);
int mx_path_is_empty (struct Buffer *path);
void mx_fastclose_mailbox (struct Mailbox *m, bool keep_account);
const struct MxOps * mx_get_ops (enum MailboxType type);
bool mx_tags_is_supported (struct Mailbox *m);
int mx_toggle_write (struct Mailbox *m);
void mx_mbox_reset_check (void);
#endif /* MUTT_MX_H */
|
