mxapi.h

Go to the documentation of this file.

 
#ifndef MUTT_CORE_MXAPI_H
#define MUTT_CORE_MXAPI_H
 
#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include "mailbox.h"
 
struct Account;
struct Buffer;
struct Email;
struct Message;
struct stat;
 
/* flags for mutt_open_mailbox() */
typedef uint8_t OpenMailboxFlags;   
#define MUTT_OPEN_NO_FLAGS       0  
#define MUTT_NOSORT        (1 << 0) 
#define MUTT_APPEND        (1 << 1) 
#define MUTT_READONLY      (1 << 2) 
#define MUTT_QUIET         (1 << 3) 
#define MUTT_PEEK          (1 << 5) 
#define MUTT_APPENDNEW     (1 << 6) 
 
typedef uint8_t CheckStatsFlags;     
#define MUTT_MAILBOX_CHECK_NO_FLAGS  0  
#define MUTT_MAILBOX_CHECK_POSTPONED (1 << 0) 
#define MUTT_MAILBOX_CHECK_STATS     (1 << 1) 
#define MUTT_MAILBOX_CHECK_IMMEDIATE (1 << 2) 

enum MxStatus
{
  MX_STATUS_ERROR = -1, 
  MX_STATUS_OK,         
  MX_STATUS_NEW_MAIL,   
  MX_STATUS_LOCKED,     
  MX_STATUS_REOPENED,   
  MX_STATUS_FLAGS,      
};

enum MxOpenReturns
{
  MX_OPEN_OK,           
  MX_OPEN_ERROR,        
  MX_OPEN_ABORT,        
};

struct MxOps
{
  enum MailboxType type;  
  const char *name;       
  bool is_local;          

  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, struct Email *e);

  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)(struct Buffer *path);

  int (*path_is_empty)(struct Buffer *path);
};
 
#endif /* MUTT_CORE_MXAPI_H */