NeoMutt  2024-04-25-89-g194907
Teaching an old dog new tricks
No Matches
Go to the documentation of this file.
25#ifndef MUTT_MX_H
26#define MUTT_MX_H
28#include <stdbool.h>
29#include <stdint.h>
30#include "core/lib.h"
32struct Buffer;
33struct Email;
35extern const struct EnumDef MboxTypeDef;
37typedef uint8_t MsgOpenFlags;
38#define MUTT_MSG_NO_FLAGS 0
39#define MUTT_ADD_FROM (1 << 0)
40#define MUTT_SET_DRAFT (1 << 1)
42/* Wrappers for the Mailbox API, see MxOps */
43enum MxStatus mx_mbox_check (struct Mailbox *m);
44enum MxStatus mx_mbox_check_stats (struct Mailbox *m, uint8_t flags);
45enum MxStatus mx_mbox_close (struct Mailbox *m);
46bool mx_mbox_open (struct Mailbox *m, OpenMailboxFlags flags);
47enum MxStatus mx_mbox_sync (struct Mailbox *m);
48int mx_msg_close (struct Mailbox *m, struct Message **ptr);
49int mx_msg_commit (struct Mailbox *m, struct Message *msg);
50struct Message * mx_msg_open_new (struct Mailbox *m, const struct Email *e, MsgOpenFlags flags);
51struct Message * mx_msg_open (struct Mailbox *m, struct Email *e);
52int mx_msg_padding_size (struct Mailbox *m);
53int mx_save_hcache (struct Mailbox *m, struct Email *e);
54int mx_path_canon (struct Buffer *path, const char *folder, enum MailboxType *type);
55int mx_path_canon2 (struct Mailbox *m, const char *folder);
56enum MailboxType mx_path_probe (const char *path);
57struct Mailbox * mx_path_resolve (const char *path);
58struct Mailbox * mx_resolve (const char *path_or_name);
59int mx_tags_commit (struct Mailbox *m, struct Email *e, const char *tags);
60int mx_tags_edit (struct Mailbox *m, const char *tags, struct Buffer *buf);
61enum MailboxType mx_type (struct Mailbox *m);
63struct Account * mx_ac_find (struct Mailbox *m);
64struct Mailbox * mx_mbox_find (struct Account *a, const char *path);
65struct Mailbox * mx_mbox_find2 (const char *path);
66bool mx_mbox_ac_link (struct Mailbox *m);
67bool mx_ac_add (struct Account *a, struct Mailbox *m);
68int mx_ac_remove (struct Mailbox *m, bool keep_account);
70int mx_access (const char *path, int flags);
71void mx_alloc_memory (struct Mailbox *m, int req_size);
72int mx_path_is_empty (struct Buffer *path);
73void mx_fastclose_mailbox (struct Mailbox *m, bool keep_account);
74const struct MxOps * mx_get_ops (enum MailboxType type);
75bool mx_tags_is_supported (struct Mailbox *m);
76int mx_toggle_write (struct Mailbox *m);
78#endif /* MUTT_MX_H */
Convenience wrapper for the core headers.
Supported mailbox formats.
Definition: mailbox.h:41
void mx_alloc_memory(struct Mailbox *m, int req_size)
Create storage for the emails.
Definition: mx.c:1206
int mx_tags_edit(struct Mailbox *m, const char *tags, struct Buffer *buf)
Start the tag editor of the mailbox.
Definition: mx.c:1274
int mx_msg_close(struct Mailbox *m, struct Message **ptr)
Close a message.
Definition: mx.c:1180
int mx_ac_remove(struct Mailbox *m, bool keep_account)
Remove a Mailbox from an Account and delete Account if empty.
Definition: mx.c:1740
int mx_access(const char *path, int flags)
Wrapper for access, checks permissions on a given mailbox.
Definition: mx.c:170
uint8_t MsgOpenFlags
Flags for mx_msg_open_new(), e.g. MUTT_ADD_FROM.
Definition: mx.h:37
const struct EnumDef MboxTypeDef
Data for the $mbox_type enumeration.
Definition: mx.c:92
int mx_msg_padding_size(struct Mailbox *m)
Bytes of padding between messages - Wrapper for MxOps::msg_padding_size()
Definition: mx.c:1505
void mx_fastclose_mailbox(struct Mailbox *m, bool keep_account)
Free up memory associated with the Mailbox.
Definition: mx.c:414
enum MxStatus mx_mbox_check_stats(struct Mailbox *m, uint8_t flags)
Check the statistics for a mailbox - Wrapper for MxOps::mbox_check_stats()
Definition: mx.c:1759
int mx_path_canon(struct Buffer *path, const char *folder, enum MailboxType *type)
Canonicalise a mailbox path - Wrapper for MxOps::path_canon()
Definition: mx.c:1367
bool mx_mbox_open(struct Mailbox *m, OpenMailboxFlags flags)
Open a mailbox and parse it.
Definition: mx.c:288
struct Mailbox * mx_mbox_find(struct Account *a, const char *path)
Find a Mailbox on an Account.
Definition: mx.c:1543
struct Mailbox * mx_resolve(const char *path_or_name)
Get a Mailbox from either a path or name.
Definition: mx.c:1705
bool mx_ac_add(struct Account *a, struct Mailbox *m)
Add a Mailbox to an Account - Wrapper for MxOps::ac_add()
Definition: mx.c:1723
struct Mailbox * mx_mbox_find2(const char *path)
Find a Mailbox on an Account.
Definition: mx.c:1605
struct Message * mx_msg_open(struct Mailbox *m, struct Email *e)
Return a stream pointer for a message.
Definition: mx.c:1134
const struct MxOps * mx_get_ops(enum MailboxType type)
Get mailbox operations.
Definition: mx.c:127
bool mx_tags_is_supported(struct Mailbox *m)
Return true if mailbox support tagging.
Definition: mx.c:1311
int mx_tags_commit(struct Mailbox *m, struct Email *e, const char *tags)
Save tags to the Mailbox - Wrapper for MxOps::tags_commit()
Definition: mx.c:1294
int mx_save_hcache(struct Mailbox *m, struct Email *e)
Save message to the header cache - Wrapper for MxOps::msg_save_hcache()
Definition: mx.c:1783
bool mx_mbox_ac_link(struct Mailbox *m)
Link a Mailbox to an existing or new Account.
Definition: mx.c:251
struct Account * mx_ac_find(struct Mailbox *m)
Find the Account owning a Mailbox.
Definition: mx.c:1519
enum MailboxType mx_type(struct Mailbox *m)
Return the type of the Mailbox.
Definition: mx.c:1796
int mx_path_is_empty(struct Buffer *path)
Is the mailbox empty.
Definition: mx.c:1252
struct Message * mx_msg_open_new(struct Mailbox *m, const struct Email *e, MsgOpenFlags flags)
Open a new message.
Definition: mx.c:1040
int mx_toggle_write(struct Mailbox *m)
Toggle the mailbox's readonly flag.
Definition: mx.c:1807
int mx_msg_commit(struct Mailbox *m, struct Message *msg)
Commit a message to a folder - Wrapper for MxOps::msg_commit()
Definition: mx.c:1159
enum MailboxType mx_path_probe(const char *path)
Find a mailbox that understands a path.
Definition: mx.c:1321
struct Mailbox * mx_path_resolve(const char *path)
Get a Mailbox for a path.
Definition: mx.c:1636
int mx_path_canon2(struct Mailbox *m, const char *folder)
Canonicalise the path to realpath.
Definition: mx.c:1471
enum MxStatus mx_mbox_check(struct Mailbox *m)
Check for new mail - Wrapper for MxOps::mbox_check()
Definition: mx.c:1105
enum MxStatus mx_mbox_sync(struct Mailbox *m)
Save changes to mailbox.
Definition: mx.c:906
enum MxStatus mx_mbox_close(struct Mailbox *m)
Save changes and close mailbox.
Definition: mx.c:598
uint8_t OpenMailboxFlags
Flags for mutt_open_mailbox(), e.g. MUTT_NOSORT.
Definition: mxapi.h:39
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition: mxapi.h:63
A group of associated Mailboxes.
Definition: account.h:36
String manipulation buffer.
Definition: buffer.h:36
The envelope/body of an email.
Definition: email.h:39
An enumeration.
Definition: enum.h:30
A mailbox.
Definition: mailbox.h:79
A local copy of an email.
Definition: message.h:34
char * path
path to temp file
Definition: message.h:36
struct Message::@0 flags
Flags for the Message.
Definition: mxapi.h:91
enum MailboxType type
Mailbox type, e.g. MUTT_IMAP.
Definition: mxapi.h:92