NeoMutt  2018-07-16 +1928-8a652d
Teaching an old dog new tricks
DOXYGEN
Mailbox Struct Reference

A mailbox. More...

#include "mailbox.h"

+ Inheritance diagram for Mailbox:
+ Collaboration diagram for Mailbox:

Data Fields

struct Bufferpathbuf
 
char * realpath
 used for duplicate detection, context comparison, and the sidebar More...
 
char * desc
 
off_t size
 
bool has_new
 mailbox has new mail More...
 
int msg_count
 total number of messages More...
 
int msg_unread
 number of unread messages More...
 
int msg_flagged
 number of flagged messages More...
 
int msg_new
 number of new messages More...
 
int msg_deleted
 number of deleted messages More...
 
int msg_tagged
 how many messages are tagged? More...
 
struct Email ** emails
 
int email_max
 number of pointers in emails More...
 
int * v2r
 mapping from virtual to real msgno More...
 
int vcount
 the number of virtual messages More...
 
bool notified
 user has been notified More...
 
enum MailboxType magic
 mailbox type More...
 
bool newly_created
 mbox or mmdf just popped into existence More...
 
struct timespec mtime
 
struct timespec last_visited
 time of last exit from this mailbox More...
 
struct timespec stats_last_checked
 mtime of mailbox the last time stats where checked. More...
 
const struct MxOpsmx_ops
 
bool append: 1
 mailbox is opened in append mode More...
 
bool changed: 1
 mailbox has been modified More...
 
bool dontwrite: 1
 don't write the mailbox on close More...
 
bool first_check_stats_done: 1
 true when the check have been done at least on time More...
 
bool peekonly: 1
 just taking a glance, revert atime More...
 
bool quiet: 1
 inhibit status messages? More...
 
bool readonly: 1
 don't allow changes to the mailbox More...
 
AclFlags rights
 ACL bits, see AclFlags. More...
 
void * compress_info
 compressed mbox module private data More...
 
struct Hashid_hash
 hash table by msg id More...
 
struct Hashsubj_hash
 hash table by subject More...
 
struct Hashlabel_hash
 hash table for x-labels More...
 
struct Accountaccount
 
int opened
 number of times mailbox is opened More...
 
int flags
 e.g. More...
 
void * mdata
 driver specific data More...
 
void(* free_mdata )(void **)
 driver-specific data free function More...
 
void(* notify2 )(struct Mailbox *m, enum MailboxNotification action)
 Notification callback. More...
 
void * ndata
 Notification callback private data. More...
 

Detailed Description

A mailbox.

Definition at line 87 of file mailbox.h.

Field Documentation

struct Buffer* Mailbox::pathbuf

Definition at line 89 of file mailbox.h.

char* Mailbox::realpath

used for duplicate detection, context comparison, and the sidebar

Definition at line 90 of file mailbox.h.

char* Mailbox::desc

Definition at line 91 of file mailbox.h.

off_t Mailbox::size

Definition at line 92 of file mailbox.h.

bool Mailbox::has_new

mailbox has new mail

Definition at line 93 of file mailbox.h.

int Mailbox::msg_count

total number of messages

Definition at line 96 of file mailbox.h.

int Mailbox::msg_unread

number of unread messages

Definition at line 97 of file mailbox.h.

int Mailbox::msg_flagged

number of flagged messages

Definition at line 98 of file mailbox.h.

int Mailbox::msg_new

number of new messages

Definition at line 99 of file mailbox.h.

int Mailbox::msg_deleted

number of deleted messages

Definition at line 100 of file mailbox.h.

int Mailbox::msg_tagged

how many messages are tagged?

Definition at line 101 of file mailbox.h.

struct Email** Mailbox::emails

Definition at line 103 of file mailbox.h.

int Mailbox::email_max

number of pointers in emails

Definition at line 104 of file mailbox.h.

int* Mailbox::v2r

mapping from virtual to real msgno

Definition at line 105 of file mailbox.h.

int Mailbox::vcount

the number of virtual messages

Definition at line 106 of file mailbox.h.

bool Mailbox::notified

user has been notified

Definition at line 108 of file mailbox.h.

enum MailboxType Mailbox::magic

mailbox type

Definition at line 109 of file mailbox.h.

bool Mailbox::newly_created

mbox or mmdf just popped into existence

Definition at line 110 of file mailbox.h.

struct timespec Mailbox::mtime

Definition at line 111 of file mailbox.h.

struct timespec Mailbox::last_visited

time of last exit from this mailbox

Definition at line 112 of file mailbox.h.

struct timespec Mailbox::stats_last_checked

mtime of mailbox the last time stats where checked.

Definition at line 113 of file mailbox.h.

const struct MxOps* Mailbox::mx_ops

Definition at line 115 of file mailbox.h.

bool Mailbox::append

mailbox is opened in append mode

Definition at line 117 of file mailbox.h.

bool Mailbox::changed

mailbox has been modified

Definition at line 118 of file mailbox.h.

bool Mailbox::dontwrite

don't write the mailbox on close

Definition at line 119 of file mailbox.h.

bool Mailbox::first_check_stats_done

true when the check have been done at least on time

Definition at line 120 of file mailbox.h.

bool Mailbox::peekonly

just taking a glance, revert atime

Definition at line 121 of file mailbox.h.

bool Mailbox::quiet

inhibit status messages?

Definition at line 122 of file mailbox.h.

bool Mailbox::readonly

don't allow changes to the mailbox

Definition at line 123 of file mailbox.h.

AclFlags Mailbox::rights

ACL bits, see AclFlags.

Definition at line 125 of file mailbox.h.

void* Mailbox::compress_info

compressed mbox module private data

Definition at line 128 of file mailbox.h.

struct Hash* Mailbox::id_hash

hash table by msg id

Definition at line 131 of file mailbox.h.

struct Hash* Mailbox::subj_hash

hash table by subject

Definition at line 132 of file mailbox.h.

struct Hash* Mailbox::label_hash

hash table for x-labels

Definition at line 133 of file mailbox.h.

struct Account* Mailbox::account

Definition at line 135 of file mailbox.h.

int Mailbox::opened

number of times mailbox is opened

Definition at line 136 of file mailbox.h.

int Mailbox::flags

e.g.

MB_NORMAL

Definition at line 138 of file mailbox.h.

void* Mailbox::mdata

driver specific data

Definition at line 140 of file mailbox.h.

void(* Mailbox::free_mdata) (void **)

driver-specific data free function

Definition at line 141 of file mailbox.h.

void(* Mailbox::notify2) (struct Mailbox *m, enum MailboxNotification action)

Notification callback.

Definition at line 143 of file mailbox.h.

void* Mailbox::ndata

Notification callback private data.

Definition at line 144 of file mailbox.h.


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