NeoMutt  2024-04-25-85-g27bab4
Teaching an old dog new tricks
No Matches
ImapMboxData Struct Reference

IMAP-specific Mailbox data -. More...

#include "mdata.h"

+ Inheritance diagram for ImapMboxData:
+ Collaboration diagram for ImapMboxData:

Public Member Functions

 ARRAY_HEAD (MSNArray, struct Email *) msn
 look up headers by (MSN-1)

Data Fields

char * name
 Mailbox name.
char * munge_name
 Munged version of the mailbox name.
char * real_name
 Original Mailbox name, e.g.: INBOX can be just \0.
ImapOpenFlags reopen
ImapOpenFlags check_status
unsigned int new_mail_count
 Set when EXISTS notifies of new mail.
struct ListHead flags
uint32_t uidvalidity
unsigned int uid_next
unsigned long long modseq
unsigned int messages
unsigned int recent
unsigned int unseen
struct HashTableuid_hash
 Hash Table: "uid" -> Email.
struct BodyCachebcache
 Email body cache.
struct HeaderCachehcache
 Email header cache.
struct timespec mtime
 Time Mailbox was last changed.
- Data Fields inherited from Mailbox
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 ConfigSubsetsub
 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 MxOpsmx_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 HashTableid_hash
 Hash Table: "message-id" -> Email.
struct HashTablesubj_hash
 Hash Table: "subject" -> Email.
struct HashTablelabel_hash
 Hash Table: "x-labels" -> Email.
struct Accountaccount
 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 Notifynotify
 Notifications: NotifyMailbox, EventMailbox.
int gen
 Generation number, for sorting.

Detailed Description

IMAP-specific Mailbox data -.

This data is specific to a Mailbox of an IMAP server

Definition at line 39 of file mdata.h.

Member Function Documentation


ImapMboxData::ARRAY_HEAD ( MSNArray  ,
struct Email  

look up headers by (MSN-1)

Field Documentation

◆ name

char* ImapMboxData::name

Mailbox name.

Definition at line 41 of file mdata.h.

◆ munge_name

char* ImapMboxData::munge_name

Munged version of the mailbox name.

Definition at line 42 of file mdata.h.

◆ real_name

char* ImapMboxData::real_name

Original Mailbox name, e.g.: INBOX can be just \0.

Definition at line 43 of file mdata.h.

◆ reopen

ImapOpenFlags ImapMboxData::reopen


Definition at line 45 of file mdata.h.

◆ check_status

ImapOpenFlags ImapMboxData::check_status


Definition at line 46 of file mdata.h.

◆ new_mail_count

unsigned int ImapMboxData::new_mail_count

Set when EXISTS notifies of new mail.

Definition at line 47 of file mdata.h.

◆ flags

struct ListHead ImapMboxData::flags

Definition at line 50 of file mdata.h.

◆ uidvalidity

uint32_t ImapMboxData::uidvalidity

Definition at line 51 of file mdata.h.

◆ uid_next

unsigned int ImapMboxData::uid_next

Definition at line 52 of file mdata.h.

◆ modseq

unsigned long long ImapMboxData::modseq

Definition at line 53 of file mdata.h.

◆ messages

unsigned int ImapMboxData::messages

Definition at line 54 of file mdata.h.

◆ recent

unsigned int ImapMboxData::recent

Definition at line 55 of file mdata.h.

◆ unseen

unsigned int ImapMboxData::unseen

Definition at line 56 of file mdata.h.

◆ uid_hash

struct HashTable* ImapMboxData::uid_hash

Hash Table: "uid" -> Email.

Definition at line 59 of file mdata.h.

◆ bcache

struct BodyCache* ImapMboxData::bcache

Email body cache.

Definition at line 61 of file mdata.h.

◆ hcache

struct HeaderCache* ImapMboxData::hcache

Email header cache.

Definition at line 63 of file mdata.h.

◆ mtime

struct timespec ImapMboxData::mtime

Time Mailbox was last changed.

Definition at line 64 of file mdata.h.

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