mailbox.h

Go to the documentation of this file.

#ifndef MUTT_CORE_MAILBOX_H
#define MUTT_CORE_MAILBOX_H

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#include <time.h>
#include "mutt/lib.h"

struct ConfigSubset;
struct Email;

#define MB_NORMAL 0
#define MB_HIDDEN 1

enum MailboxType
{
  MUTT_MAILBOX_ANY = -2,   
  MUTT_MAILBOX_ERROR = -1, 
  MUTT_UNKNOWN = 0,        
  MUTT_MBOX,               
  MUTT_MMDF,               
  MUTT_MH,                 
  MUTT_MAILDIR,            
  MUTT_NNTP,               
  MUTT_IMAP,               
  MUTT_NOTMUCH,            
  MUTT_POP,                
  MUTT_COMPRESSED,         
};

typedef uint16_t AclFlags;          
#define MUTT_ACL_NO_FLAGS       0   
#define MUTT_ACL_ADMIN   (1 <<  0)  
#define MUTT_ACL_CREATE  (1 <<  1)  
#define MUTT_ACL_DELETE  (1 <<  2)  
#define MUTT_ACL_DELMX   (1 <<  3)  
#define MUTT_ACL_EXPUNGE (1 <<  4)  
#define MUTT_ACL_INSERT  (1 <<  5)  
#define MUTT_ACL_LOOKUP  (1 <<  6)  
#define MUTT_ACL_POST    (1 <<  7)  
#define MUTT_ACL_READ    (1 <<  8)  
#define MUTT_ACL_SEEN    (1 <<  9)  
#define MUTT_ACL_WRITE   (1 << 10)  

#define MUTT_ACL_ALL    ((1 << 11) - 1)

struct Mailbox
{
  struct Buffer pathbuf;
  char *realpath;                     
  char *name;                         
  struct ConfigSubset *sub;           
  off_t size;                         
  bool has_new;                       

  // These next three are only set when MailCheckStats is set
  int msg_count;                      
  int msg_unread;                     
  int msg_flagged;                    

  int msg_new;                        
  int msg_deleted;                    
  int msg_tagged;                     

  struct Email **emails;              
  int email_max;                      
  int *v2r;                           
  int vcount;                         

  bool notified;                      
  enum MailboxType type;              
  bool newly_created;                 
  struct timespec mtime;              
  struct timespec last_visited;       
  struct timespec stats_last_checked; 

  const struct MxOps *mx_ops;         

  bool append                 : 1;    
  bool changed                : 1;    
  bool dontwrite              : 1;    
  bool first_check_stats_done : 1;    
  bool peekonly               : 1;    
  bool verbose                : 1;    
  bool readonly               : 1;    

  AclFlags rights;                    

#ifdef USE_COMP_MBOX
  void *compress_info;                
#endif

  struct HashTable *id_hash;          
  struct HashTable *subj_hash;        
  struct HashTable *label_hash;       

  struct Account *account;            
  int opened;                         

  uint8_t flags;                      

  void *mdata;                        

  void (*mdata_free)(void **ptr);

  struct Notify *notify;              

  int gen;                            
};

struct MailboxNode
{
  struct Mailbox *mailbox;           
  STAILQ_ENTRY(MailboxNode) entries; 
};
STAILQ_HEAD(MailboxList, MailboxNode);

enum NotifyMailbox
{
  NT_MAILBOX_ADD = 1,    
  NT_MAILBOX_DELETE,     
  NT_MAILBOX_DELETE_ALL, 
  NT_MAILBOX_CHANGE,     

  /* These don't really belong here as they are tied to GUI operations.
   * Eventually, they'll be eliminated. */
  NT_MAILBOX_INVALID,    
  NT_MAILBOX_RESORT,     
  NT_MAILBOX_SWITCH,     
  NT_MAILBOX_UPDATE,     
  NT_MAILBOX_UNTAG,      
};

struct EventMailbox
{
  struct Mailbox *mailbox; 
};

void            mailbox_changed   (struct Mailbox *m, enum NotifyMailbox action);
struct Mailbox *mailbox_find      (const char *path);
struct Mailbox *mailbox_find_name (const char *name);
void            mailbox_free      (struct Mailbox **ptr);
int             mailbox_gen       (void);
struct Mailbox *mailbox_new       (void);
bool            mailbox_set_subset(struct Mailbox *m, struct ConfigSubset *sub);
void            mailbox_size_add  (struct Mailbox *m, const struct Email *e);
void            mailbox_size_sub  (struct Mailbox *m, const struct Email *e);
void            mailbox_update    (struct Mailbox *m);
void            mailbox_gc_add    (struct Email *e);
void            mailbox_gc_run    (void);

const char *mailbox_get_type_name(enum MailboxType type);

static inline const char *mailbox_path(const struct Mailbox *m) // LCOV_EXCL_LINE
{
  return mutt_buffer_string(&m->pathbuf); // LCOV_EXCL_LINE
}

#endif /* MUTT_CORE_MAILBOX_H */