NeoMutt  2023-03-22-27-g3cb248
Teaching an old dog new tricks
DOXYGEN
MxOps Struct Reference

#include "mxapi.h"

Data Fields

enum MailboxType type
 Mailbox type, e.g. MUTT_IMAP. More...
 
const char * name
 Mailbox name, e.g. "imap". More...
 
bool is_local
 True, if Mailbox type has local files/dirs. More...
 
bool(* ac_owns_path )(struct Account *a, const char *path)
 
bool(* ac_add )(struct Account *a, struct Mailbox *m)
 
enum MxOpenReturns(* mbox_open )(struct Mailbox *m)
 
bool(* mbox_open_append )(struct Mailbox *m, OpenMailboxFlags flags)
 
enum MxStatus(* mbox_check )(struct Mailbox *m)
 
enum MxStatus(* mbox_check_stats )(struct Mailbox *m, CheckStatsFlags flags)
 
enum MxStatus(* mbox_sync )(struct Mailbox *m)
 
enum MxStatus(* mbox_close )(struct Mailbox *m)
 
bool(* msg_open )(struct Mailbox *m, struct Message *msg, int msgno)
 
bool(* msg_open_new )(struct Mailbox *m, struct Message *msg, const struct Email *e)
 
int(* msg_commit )(struct Mailbox *m, struct Message *msg)
 
int(* msg_close )(struct Mailbox *m, struct Message *msg)
 
int(* msg_padding_size )(struct Mailbox *m)
 
int(* msg_save_hcache )(struct Mailbox *m, struct Email *e)
 
int(* tags_edit )(struct Mailbox *m, const char *tags, struct Buffer *buf)
 
int(* tags_commit )(struct Mailbox *m, struct Email *e, const char *buf)
 
enum MailboxType(* path_probe )(const char *path, const struct stat *st)
 
int(* path_canon )(char *buf, size_t buflen)
 
int(* path_pretty )(char *buf, size_t buflen, const char *folder)
 
int(* path_parent )(char *buf, size_t buflen)
 
int(* path_is_empty )(const char *path)
 

Detailed Description

Definition at line 111 of file mxapi.h.

Field Documentation

◆ type

enum MailboxType MxOps::type

Mailbox type, e.g. MUTT_IMAP.

Definition at line 113 of file mxapi.h.

◆ name

const char* MxOps::name

Mailbox name, e.g. "imap".

Definition at line 114 of file mxapi.h.

◆ is_local

bool MxOps::is_local

True, if Mailbox type has local files/dirs.

Definition at line 115 of file mxapi.h.

◆ ac_owns_path

bool(* MxOps::ac_owns_path) (struct Account *a, const char *path)

Definition at line 130 of file mxapi.h.

◆ ac_add

bool(* MxOps::ac_add) (struct Account *a, struct Mailbox *m)

Definition at line 145 of file mxapi.h.

◆ mbox_open

enum MxOpenReturns(* MxOps::mbox_open) (struct Mailbox *m)

Definition at line 145 of file mxapi.h.

◆ mbox_open_append

bool(* MxOps::mbox_open_append) (struct Mailbox *m, OpenMailboxFlags flags)

Definition at line 171 of file mxapi.h.

◆ mbox_check

enum MxStatus(* MxOps::mbox_check) (struct Mailbox *m)

Definition at line 171 of file mxapi.h.

◆ mbox_check_stats

enum MxStatus(* MxOps::mbox_check_stats) (struct Mailbox *m, CheckStatsFlags flags)

Definition at line 171 of file mxapi.h.

◆ mbox_sync

enum MxStatus(* MxOps::mbox_sync) (struct Mailbox *m)

Definition at line 171 of file mxapi.h.

◆ mbox_close

enum MxStatus(* MxOps::mbox_close) (struct Mailbox *m)

Definition at line 171 of file mxapi.h.

◆ msg_open

bool(* MxOps::msg_open) (struct Mailbox *m, struct Message *msg, int msgno)

Definition at line 237 of file mxapi.h.

◆ msg_open_new

bool(* MxOps::msg_open_new) (struct Mailbox *m, struct Message *msg, const struct Email *e)

Definition at line 253 of file mxapi.h.

◆ msg_commit

int(* MxOps::msg_commit) (struct Mailbox *m, struct Message *msg)

Definition at line 268 of file mxapi.h.

◆ msg_close

int(* MxOps::msg_close) (struct Mailbox *m, struct Message *msg)

Definition at line 283 of file mxapi.h.

◆ msg_padding_size

int(* MxOps::msg_padding_size) (struct Mailbox *m)

Definition at line 295 of file mxapi.h.

◆ msg_save_hcache

int(* MxOps::msg_save_hcache) (struct Mailbox *m, struct Email *e)

Definition at line 310 of file mxapi.h.

◆ tags_edit

int(* MxOps::tags_edit) (struct Mailbox *m, const char *tags, struct Buffer *buf)

Definition at line 327 of file mxapi.h.

◆ tags_commit

int(* MxOps::tags_commit) (struct Mailbox *m, struct Email *e, const char *buf)

Definition at line 344 of file mxapi.h.

◆ path_probe

enum MailboxType(* MxOps::path_probe) (const char *path, const struct stat *st)

Definition at line 344 of file mxapi.h.

◆ path_canon

int(* MxOps::path_canon) (char *buf, size_t buflen)

Definition at line 371 of file mxapi.h.

◆ path_pretty

int(* MxOps::path_pretty) (char *buf, size_t buflen, const char *folder)

Definition at line 386 of file mxapi.h.

◆ path_parent

int(* MxOps::path_parent) (char *buf, size_t buflen)

Definition at line 400 of file mxapi.h.

◆ path_is_empty

int(* MxOps::path_is_empty) (const char *path)

Definition at line 414 of file mxapi.h.


The documentation for this struct was generated from the following file: