NeoMutt  2018-07-16 +2481-68dcde
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 Buffer pathbuf
 
char * realpath
 Used for duplicate detection, context comparison, and the sidebar. More...
 
char * name
 A short name for the Mailbox. More...
 
struct ConfigSubsetsub
 Inherited config items. More...
 
off_t size
 Size of the Mailbox. More...
 
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
 Array of Emails. More...
 
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
 Time Mailbox was last changed. More...
 
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
 MXAPI callback functions. More...
 
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
 Account that owns this Mailbox. More...
 
int opened
 Number of times mailbox is opened. More...
 
int flags
 e.g. MB_NORMAL More...
 
void * mdata
 Driver specific data. More...
 
void(* free_mdata )(void **)
 Driver-specific data free function. More...
 
struct Notifynotify
 Notifications handler. More...
 

Detailed Description

A mailbox.

Definition at line 92 of file mailbox.h.

Field Documentation

◆ pathbuf

struct Buffer Mailbox::pathbuf

Definition at line 94 of file mailbox.h.

◆ realpath

char* Mailbox::realpath

Used for duplicate detection, context comparison, and the sidebar.

Definition at line 95 of file mailbox.h.

◆ name

char* Mailbox::name

A short name for the Mailbox.

Definition at line 96 of file mailbox.h.

◆ sub

struct ConfigSubset* Mailbox::sub

Inherited config items.

Definition at line 97 of file mailbox.h.

◆ size

off_t Mailbox::size

Size of the Mailbox.

Definition at line 98 of file mailbox.h.

◆ has_new

bool Mailbox::has_new

Mailbox has new mail.

Definition at line 99 of file mailbox.h.

◆ msg_count

int Mailbox::msg_count

Total number of messages.

Definition at line 102 of file mailbox.h.

◆ msg_unread

int Mailbox::msg_unread

Number of unread messages.

Definition at line 103 of file mailbox.h.

◆ msg_flagged

int Mailbox::msg_flagged

Number of flagged messages.

Definition at line 104 of file mailbox.h.

◆ msg_new

int Mailbox::msg_new

Number of new messages.

Definition at line 106 of file mailbox.h.

◆ msg_deleted

int Mailbox::msg_deleted

Number of deleted messages.

Definition at line 107 of file mailbox.h.

◆ msg_tagged

int Mailbox::msg_tagged

How many messages are tagged?

Definition at line 108 of file mailbox.h.

◆ emails

struct Email** Mailbox::emails

Array of Emails.

Definition at line 110 of file mailbox.h.

◆ email_max

int Mailbox::email_max

Number of pointers in emails.

Definition at line 111 of file mailbox.h.

◆ v2r

int* Mailbox::v2r

Mapping from virtual to real msgno.

Definition at line 112 of file mailbox.h.

◆ vcount

int Mailbox::vcount

The number of virtual messages.

Definition at line 113 of file mailbox.h.

◆ notified

bool Mailbox::notified

User has been notified.

Definition at line 115 of file mailbox.h.

◆ magic

enum MailboxType Mailbox::magic

Mailbox type.

Definition at line 116 of file mailbox.h.

◆ newly_created

bool Mailbox::newly_created

Mbox or mmdf just popped into existence.

Definition at line 117 of file mailbox.h.

◆ mtime

struct timespec Mailbox::mtime

Time Mailbox was last changed.

Definition at line 118 of file mailbox.h.

◆ last_visited

struct timespec Mailbox::last_visited

Time of last exit from this mailbox.

Definition at line 119 of file mailbox.h.

◆ stats_last_checked

struct timespec Mailbox::stats_last_checked

Mtime of mailbox the last time stats where checked.

Definition at line 120 of file mailbox.h.

◆ mx_ops

const struct MxOps* Mailbox::mx_ops

MXAPI callback functions.

Definition at line 122 of file mailbox.h.

◆ append

bool Mailbox::append

Mailbox is opened in append mode.

Definition at line 124 of file mailbox.h.

◆ changed

bool Mailbox::changed

Mailbox has been modified.

Definition at line 125 of file mailbox.h.

◆ dontwrite

bool Mailbox::dontwrite

Don't write the mailbox on close.

Definition at line 126 of file mailbox.h.

◆ first_check_stats_done

bool Mailbox::first_check_stats_done

True when the check have been done at least on time.

Definition at line 127 of file mailbox.h.

◆ peekonly

bool Mailbox::peekonly

Just taking a glance, revert atime.

Definition at line 128 of file mailbox.h.

◆ quiet

bool Mailbox::quiet

Inhibit status messages?

Definition at line 129 of file mailbox.h.

◆ readonly

bool Mailbox::readonly

Don't allow changes to the mailbox.

Definition at line 130 of file mailbox.h.

◆ rights

AclFlags Mailbox::rights

ACL bits, see AclFlags.

Definition at line 132 of file mailbox.h.

◆ compress_info

void* Mailbox::compress_info

Compressed mbox module private data.

Definition at line 135 of file mailbox.h.

◆ id_hash

struct Hash* Mailbox::id_hash

Hash table by msg id.

Definition at line 138 of file mailbox.h.

◆ subj_hash

struct Hash* Mailbox::subj_hash

Hash table by subject.

Definition at line 139 of file mailbox.h.

◆ label_hash

struct Hash* Mailbox::label_hash

Hash table for x-labels.

Definition at line 140 of file mailbox.h.

◆ account

struct Account* Mailbox::account

Account that owns this Mailbox.

Definition at line 142 of file mailbox.h.

◆ opened

int Mailbox::opened

Number of times mailbox is opened.

Definition at line 143 of file mailbox.h.

◆ flags

int Mailbox::flags

e.g. MB_NORMAL

Definition at line 145 of file mailbox.h.

◆ mdata

void* Mailbox::mdata

Driver specific data.

Definition at line 147 of file mailbox.h.

◆ free_mdata

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

Driver-specific data free function.

Definition at line 148 of file mailbox.h.

◆ notify

struct Notify* Mailbox::notify

Notifications handler.

Definition at line 150 of file mailbox.h.


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