A mailbox. More...

#include "mailbox.h"

Inheritance diagram for Mailbox:

Collaboration diagram for Mailbox:

Data Fields
struct Buffer	pathbuf
	Path of the Mailbox.

char *	realpath
	Used for duplicate detection, context comparison, and the sidebar.

char *	name
	A short name for the Mailbox.

struct ConfigSubset *	sub
	Inherited config items.

off_t	size
	Size of the Mailbox.

bool	has_new
	Mailbox has new mail.

int	msg_count
	Total number of messages.

int	msg_unread
	Number of unread messages.

int	msg_flagged
	Number of flagged messages.

int	msg_new
	Number of new messages.

int	msg_deleted
	Number of deleted messages.

int	msg_tagged
	How many messages are tagged?

struct Email **	emails
	Array of Emails.

int	email_max
	Size of `emails` array.

int *	v2r
	Mapping from virtual to real msgno.

int	vcount
	The number of virtual messages.

bool	notified
	User has been notified.

enum MailboxType	type
	Mailbox type.

bool	newly_created
	Mbox or mmdf just popped into existence.

struct timespec	last_visited
	Time of last exit from this mailbox.

time_t	last_checked
	Last time we checked this mailbox for new mail.

const struct MxOps *	mx_ops
	MXAPI callback functions.

bool	append: 1
	Mailbox is opened in append mode.

bool	changed: 1
	Mailbox has been modified.

bool	dontwrite: 1
	Don't write the mailbox on close.

bool	first_check_stats_done: 1
	True when the check have been done at least one time.

bool	notify_user: 1
	Notify the user of new mail.

bool	peekonly: 1
	Just taking a glance, revert atime.

bool	poll_new_mail: 1
	Check for new mail.

bool	readonly: 1
	Don't allow changes to the mailbox.

bool	verbose: 1
	Display status messages?

AclFlags	rights
	ACL bits, see AclFlags.

void *	compress_info
	Compressed mbox module private data.

struct HashTable *	id_hash
	Hash Table: "message-id" -> Email.

struct HashTable *	subj_hash
	Hash Table: "subject" -> Email.

struct HashTable *	label_hash
	Hash Table: "x-labels" -> Email.

struct Account *	account
	Account that owns this Mailbox.

int	opened
	Number of times mailbox is opened.

bool	visible
	True if a result of "mailboxes".

void *	mdata
	Driver specific data.

void(*	mdata_free )(void **ptr)

struct Notify *	notify
	Notifications: NotifyMailbox, EventMailbox.

int	gen
	Generation number, for sorting.

Detailed Description

A mailbox.

Definition at line 78 of file mailbox.h.

Field Documentation

◆ pathbuf

struct Buffer Mailbox::pathbuf

Path of the Mailbox.

Definition at line 80 of file mailbox.h.

◆ realpath

char* Mailbox::realpath

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

Definition at line 81 of file mailbox.h.

◆ name

char* Mailbox::name

A short name for the Mailbox.

Definition at line 82 of file mailbox.h.

◆ sub

struct ConfigSubset* Mailbox::sub

Inherited config items.

Definition at line 83 of file mailbox.h.

◆ size

off_t Mailbox::size

Size of the Mailbox.

Definition at line 84 of file mailbox.h.

◆ has_new

bool Mailbox::has_new

Mailbox has new mail.

Definition at line 85 of file mailbox.h.

◆ msg_count

int Mailbox::msg_count

Total number of messages.

Definition at line 88 of file mailbox.h.

◆ msg_unread

int Mailbox::msg_unread

Number of unread messages.

Definition at line 89 of file mailbox.h.

◆ msg_flagged

int Mailbox::msg_flagged

Number of flagged messages.

Definition at line 90 of file mailbox.h.

◆ msg_new

int Mailbox::msg_new

Number of new messages.

Definition at line 92 of file mailbox.h.

◆ msg_deleted

int Mailbox::msg_deleted

Number of deleted messages.

Definition at line 93 of file mailbox.h.

◆ msg_tagged

int Mailbox::msg_tagged

How many messages are tagged?

Definition at line 94 of file mailbox.h.

◆ emails

struct Email** Mailbox::emails

Array of Emails.

Definition at line 96 of file mailbox.h.

◆ email_max

int Mailbox::email_max

Size of emails array.

Definition at line 97 of file mailbox.h.

◆ v2r

int* Mailbox::v2r

Mapping from virtual to real msgno.

Definition at line 98 of file mailbox.h.

◆ vcount

int Mailbox::vcount

The number of virtual messages.

Definition at line 99 of file mailbox.h.

◆ notified

bool Mailbox::notified

User has been notified.

Definition at line 101 of file mailbox.h.

◆ type

enum MailboxType Mailbox::type

Mailbox type.

Definition at line 102 of file mailbox.h.

◆ newly_created

bool Mailbox::newly_created

Mbox or mmdf just popped into existence.

Definition at line 103 of file mailbox.h.

◆ last_visited

struct timespec Mailbox::last_visited

Time of last exit from this mailbox.

Definition at line 104 of file mailbox.h.

◆ last_checked

time_t Mailbox::last_checked

Last time we checked this mailbox for new mail.

Definition at line 105 of file mailbox.h.

◆ mx_ops

const struct MxOps* Mailbox::mx_ops

MXAPI callback functions.

Definition at line 107 of file mailbox.h.

◆ append

bool Mailbox::append

Mailbox is opened in append mode.

Definition at line 109 of file mailbox.h.

◆ changed

bool Mailbox::changed

Mailbox has been modified.

Definition at line 110 of file mailbox.h.

◆ dontwrite

bool Mailbox::dontwrite

Don't write the mailbox on close.

Definition at line 111 of file mailbox.h.

◆ first_check_stats_done

bool Mailbox::first_check_stats_done

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

Definition at line 112 of file mailbox.h.

◆ notify_user

bool Mailbox::notify_user

Notify the user of new mail.

Definition at line 113 of file mailbox.h.

◆ peekonly

bool Mailbox::peekonly

Just taking a glance, revert atime.

Definition at line 114 of file mailbox.h.

◆ poll_new_mail

bool Mailbox::poll_new_mail

Check for new mail.

Definition at line 115 of file mailbox.h.

◆ readonly

bool Mailbox::readonly

Don't allow changes to the mailbox.

Definition at line 116 of file mailbox.h.

◆ verbose

bool Mailbox::verbose

Display status messages?

Definition at line 117 of file mailbox.h.

◆ rights

AclFlags Mailbox::rights

ACL bits, see AclFlags.

Definition at line 119 of file mailbox.h.

◆ compress_info

void* Mailbox::compress_info

Compressed mbox module private data.

Definition at line 121 of file mailbox.h.

◆ id_hash

struct HashTable* Mailbox::id_hash

Hash Table: "message-id" -> Email.

Definition at line 123 of file mailbox.h.

◆ subj_hash

struct HashTable* Mailbox::subj_hash

Hash Table: "subject" -> Email.

Definition at line 124 of file mailbox.h.

◆ label_hash

struct HashTable* Mailbox::label_hash

Hash Table: "x-labels" -> Email.

Definition at line 125 of file mailbox.h.

◆ account

struct Account* Mailbox::account

Account that owns this Mailbox.

Definition at line 127 of file mailbox.h.

◆ opened

int Mailbox::opened

Number of times mailbox is opened.

Definition at line 128 of file mailbox.h.

◆ visible

bool Mailbox::visible

True if a result of "mailboxes".

Definition at line 130 of file mailbox.h.

◆ mdata

void* Mailbox::mdata

Driver specific data.

Definition at line 132 of file mailbox.h.

◆ mdata_free

void(* Mailbox::mdata_free) (void **ptr)

Definition at line 143 of file mailbox.h.

◆ notify

struct Notify* Mailbox::notify

Notifications: NotifyMailbox, EventMailbox.

Definition at line 145 of file mailbox.h.

◆ gen

int Mailbox::gen

Generation number, for sorting.

Definition at line 147 of file mailbox.h.

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

core/mailbox.h

Data Fields