NeoMutt  2024-03-23-142-g2b2e76
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
mailbox.c File Reference

Representation of a mailbox. More...

#include "config.h"
#include <assert.h>
#include <sys/stat.h>
#include "config/lib.h"
#include "email/lib.h"
#include "mailbox.h"
#include "neomutt.h"
+ Include dependency graph for mailbox.c:

Go to the source code of this file.

Data Structures

struct  EmailGarbageCollector
 Email garbage collection. More...
 

Functions

int mailbox_gen (void)
 Get the next generation number.
 
struct Mailboxmailbox_new (void)
 Create a new Mailbox.
 
void mailbox_free (struct Mailbox **ptr)
 Free a Mailbox.
 
struct Mailboxmailbox_find (const char *path)
 Find the mailbox with a given path.
 
struct Mailboxmailbox_find_name (const char *name)
 Find the mailbox with a given name.
 
void mailbox_update (struct Mailbox *m)
 Get the mailbox's current size.
 
void mailbox_changed (struct Mailbox *m, enum NotifyMailbox action)
 Notify observers of a change to a Mailbox.
 
void mailbox_size_add (struct Mailbox *m, const struct Email *e)
 Add an email's size to the total size of a Mailbox.
 
void mailbox_size_sub (struct Mailbox *m, const struct Email *e)
 Subtract an email's size from the total size of a Mailbox.
 
bool mailbox_set_subset (struct Mailbox *m, struct ConfigSubset *sub)
 Set a Mailbox's Config Subset.
 
void mailbox_gc_add (struct Email *e)
 Add an Email to the garbage-collection set.
 
void mailbox_gc_run (void)
 Run the garbage-collection.
 
const char * mailbox_get_type_name (enum MailboxType type)
 Get the type of a Mailbox.
 

Variables

static const struct Mapping MailboxTypes []
 Lookups for Mailbox types.
 
static struct EmailGarbageCollector GC = { 0 }
 Set of Emails to be deleted.
 

Detailed Description

Representation of a mailbox.

Authors
  • Kevin J. McCarthy
  • Richard Russon
  • Pietro Cerutti

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file mailbox.c.

Function Documentation

◆ mailbox_gen()

int mailbox_gen ( void  )

Get the next generation number.

Return values
numUnique number

Definition at line 59 of file mailbox.c.

60{
61 static int gen = 0;
62 return gen++;
63}
+ Here is the caller graph for this function:

◆ mailbox_new()

struct Mailbox * mailbox_new ( void  )

Create a new Mailbox.

Return values
ptrNew Mailbox

Definition at line 69 of file mailbox.c.

70{
71 struct Mailbox *m = mutt_mem_calloc(1, sizeof(struct Mailbox));
72
73 buf_init(&m->pathbuf);
74 m->notify = notify_new();
75
76 m->email_max = 25;
77 m->emails = mutt_mem_calloc(m->email_max, sizeof(struct Email *));
78 m->v2r = mutt_mem_calloc(m->email_max, sizeof(int));
79 m->gen = mailbox_gen();
80 m->notify_user = true;
81 m->poll_new_mail = true;
82
83 return m;
84}
struct Buffer * buf_init(struct Buffer *buf)
Initialise a new Buffer.
Definition: buffer.c:60
int mailbox_gen(void)
Get the next generation number.
Definition: mailbox.c:59
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
struct Notify * notify_new(void)
Create a new notifications handler.
Definition: notify.c:62
The envelope/body of an email.
Definition: email.h:39
A mailbox.
Definition: mailbox.h:79
int * v2r
Mapping from virtual to real msgno.
Definition: mailbox.h:98
int email_max
Size of emails array.
Definition: mailbox.h:97
bool poll_new_mail
Check for new mail.
Definition: mailbox.h:115
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
struct Notify * notify
Notifications: NotifyMailbox, EventMailbox.
Definition: mailbox.h:145
bool notify_user
Notify the user of new mail.
Definition: mailbox.h:113
struct Buffer pathbuf
Path of the Mailbox.
Definition: mailbox.h:80
int gen
Generation number, for sorting.
Definition: mailbox.h:147
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_free()

void mailbox_free ( struct Mailbox **  ptr)

Free a Mailbox.

Parameters
[out]ptrMailbox to free

Definition at line 90 of file mailbox.c.

91{
92 if (!ptr || !*ptr)
93 return;
94
95 struct Mailbox *m = *ptr;
96
97 const bool do_free = (m->opened == 0) && !m->visible;
98
99 mutt_debug(LL_DEBUG3, "%sfreeing %s mailbox %s with refcount %d\n",
100 do_free ? "" : "not ", m->visible ? "visible" : "invisible",
101 buf_string(&m->pathbuf), m->opened);
102
103 if (!do_free)
104 {
105 return;
106 }
107
108 mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE: %s %p\n",
109 mailbox_get_type_name(m->type), (void *) m);
110 struct EventMailbox ev_m = { m };
112
113 mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE_ALL\n");
114 struct EventEmail ev_e = { 0, NULL };
116
117 for (size_t i = 0; i < m->email_max; i++)
118 email_free(&m->emails[i]);
119
120 m->email_max = 0;
121 m->msg_count = 0;
122 m->msg_deleted = 0;
123 m->msg_flagged = 0;
124 m->msg_new = 0;
125 m->msg_tagged = 0;
126 m->msg_unread = 0;
127
128 if (m->mdata_free && m->mdata)
129 m->mdata_free(&m->mdata);
130
131 buf_dealloc(&m->pathbuf);
132 cs_subset_free(&m->sub);
133 FREE(&m->name);
134 FREE(&m->realpath);
135 FREE(&m->emails);
136 FREE(&m->v2r);
137 notify_free(&m->notify);
139
140 /* The NT_MAILBOX_DELETE notification might already have caused *ptr to be NULL,
141 * so call free() on the m pointer */
142 *ptr = NULL;
143 FREE(&m);
144}
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:376
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
void mailbox_gc_run(void)
Run the garbage-collection.
Definition: mailbox.c:313
const char * mailbox_get_type_name(enum MailboxType type)
Get the type of a Mailbox.
Definition: mailbox.c:327
@ NT_MAILBOX_DELETE
Mailbox is about to be deleted.
Definition: mailbox.h:183
void email_free(struct Email **ptr)
Free an Email.
Definition: email.c:46
@ NT_EMAIL_DELETE_ALL
All the Emails are about to be deleted.
Definition: email.h:188
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG3
Log at debug level 3.
Definition: logging2.h:45
@ LL_NOTIFY
Log of notifications.
Definition: logging2.h:48
#define FREE(x)
Definition: memory.h:45
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:173
void notify_free(struct Notify **ptr)
Free a notification handler.
Definition: notify.c:75
@ NT_EMAIL
Email has changed, NotifyEmail, EventEmail.
Definition: notify_type.h:44
@ NT_MAILBOX
Mailbox has changed, NotifyMailbox, EventMailbox.
Definition: notify_type.h:49
An Event that happened to an Email.
Definition: email.h:199
An Event that happened to a Mailbox.
Definition: mailbox.h:199
void(* mdata_free)(void **ptr)
Definition: mailbox.h:143
char * realpath
Used for duplicate detection, context comparison, and the sidebar.
Definition: mailbox.h:81
int msg_new
Number of new messages.
Definition: mailbox.h:92
int msg_count
Total number of messages.
Definition: mailbox.h:88
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
void * mdata
Driver specific data.
Definition: mailbox.h:132
char * name
A short name for the Mailbox.
Definition: mailbox.h:82
int msg_deleted
Number of deleted messages.
Definition: mailbox.h:93
bool visible
True if a result of "mailboxes".
Definition: mailbox.h:130
int msg_flagged
Number of flagged messages.
Definition: mailbox.h:90
int opened
Number of times mailbox is opened.
Definition: mailbox.h:128
int msg_tagged
How many messages are tagged?
Definition: mailbox.h:94
int msg_unread
Number of unread messages.
Definition: mailbox.h:89
struct ConfigSubset * sub
Inherited config items.
Definition: mailbox.h:83
void cs_subset_free(struct ConfigSubset **ptr)
Free a Config Subset.
Definition: subset.c:108
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_find()

struct Mailbox * mailbox_find ( const char *  path)

Find the mailbox with a given path.

Parameters
pathPath to match
Return values
ptrMatching Mailbox

Definition at line 151 of file mailbox.c.

152{
153 if (!path)
154 return NULL;
155
156 struct stat st = { 0 };
157 struct stat st_tmp = { 0 };
158
159 if (stat(path, &st) != 0)
160 return NULL;
161
162 struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
164 struct MailboxNode *np = NULL;
165 struct Mailbox *m = NULL;
166 STAILQ_FOREACH(np, &ml, entries)
167 {
168 if ((stat(mailbox_path(np->mailbox), &st_tmp) == 0) &&
169 (st.st_dev == st_tmp.st_dev) && (st.st_ino == st_tmp.st_ino))
170 {
171 m = np->mailbox;
172 break;
173 }
174 }
176
177 return m;
178}
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:223
@ MUTT_MAILBOX_ANY
Match any Mailbox type.
Definition: mailbox.h:42
void neomutt_mailboxlist_clear(struct MailboxList *ml)
Free a Mailbox List.
Definition: neomutt.c:163
size_t neomutt_mailboxlist_get_all(struct MailboxList *head, struct NeoMutt *n, enum MailboxType type)
Get a List of all Mailboxes.
Definition: neomutt.c:186
#define STAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
List of Mailboxes.
Definition: mailbox.h:166
struct Mailbox * mailbox
Mailbox in the list.
Definition: mailbox.h:167
Container for Accounts, Notifications.
Definition: neomutt.h:41
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_find_name()

struct Mailbox * mailbox_find_name ( const char *  name)

Find the mailbox with a given name.

Parameters
nameName to match
Return values
ptrMatching Mailbox
NULLNo matching mailbox found
Note
This searches across all Accounts

Definition at line 188 of file mailbox.c.

189{
190 if (!name)
191 return NULL;
192
193 struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
195 struct MailboxNode *np = NULL;
196 struct Mailbox *m = NULL;
197 STAILQ_FOREACH(np, &ml, entries)
198 {
199 if (mutt_str_equal(np->mailbox->name, name))
200 {
201 m = np->mailbox;
202 break;
203 }
204 }
206
207 return m;
208}
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:709
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_update()

void mailbox_update ( struct Mailbox m)

Get the mailbox's current size.

Parameters
mMailbox to check
Note
Only applies to local Mailboxes

Definition at line 216 of file mailbox.c.

217{
218 struct stat st = { 0 };
219
220 if (!m)
221 return;
222
223 if (stat(mailbox_path(m), &st) == 0)
224 m->size = (off_t) st.st_size;
225 else
226 m->size = 0;
227}
off_t size
Size of the Mailbox.
Definition: mailbox.h:84
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_changed()

void mailbox_changed ( struct Mailbox m,
enum NotifyMailbox  action 
)

Notify observers of a change to a Mailbox.

Parameters
mMailbox
actionChange to Mailbox

Definition at line 234 of file mailbox.c.

235{
236 if (!m)
237 return;
238
239 mutt_debug(LL_NOTIFY, "NT_MAILBOX_CHANGE: %s %p\n",
240 mailbox_get_type_name(m->type), (void *) m);
241 struct EventMailbox ev_m = { m };
242 notify_send(m->notify, NT_MAILBOX, action, &ev_m);
243}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_size_add()

void mailbox_size_add ( struct Mailbox m,
const struct Email e 
)

Add an email's size to the total size of a Mailbox.

Parameters
mMailbox
eEmail

Definition at line 250 of file mailbox.c.

251{
252 m->size += email_size(e);
253}
size_t email_size(const struct Email *e)
Compute the size of an email.
Definition: email.c:127
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_size_sub()

void mailbox_size_sub ( struct Mailbox m,
const struct Email e 
)

Subtract an email's size from the total size of a Mailbox.

Parameters
mMailbox
eEmail

Definition at line 260 of file mailbox.c.

261{
262 m->size -= email_size(e);
263}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_set_subset()

bool mailbox_set_subset ( struct Mailbox m,
struct ConfigSubset sub 
)

Set a Mailbox's Config Subset.

Parameters
mMailbox
subParent Config Subset
Return values
trueSuccess

Definition at line 271 of file mailbox.c.

272{
273 if (!m || m->sub || !sub)
274 return false;
275
276 m->sub = cs_subset_new(m->name, sub, m->notify);
278 return true;
279}
enum ConfigScope scope
Scope of Subset, e.g. SET_SCOPE_ACCOUNT.
Definition: subset.h:49
struct ConfigSubset * cs_subset_new(const char *name, struct ConfigSubset *sub_parent, struct Notify *not_parent)
Create a new Config Subset.
Definition: subset.c:152
@ SET_SCOPE_MAILBOX
This Config is Mailbox-specific.
Definition: subset.h:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_gc_add()

void mailbox_gc_add ( struct Email e)

Add an Email to the garbage-collection set.

Parameters
eEmail
Precondition
e is not NULL

Definition at line 299 of file mailbox.c.

300{
301 assert(e);
302 if (GC.idx == mutt_array_size(GC.arr))
303 {
305 }
306 GC.arr[GC.idx] = e;
307 GC.idx++;
308}
static struct EmailGarbageCollector GC
Set of Emails to be deleted.
Definition: mailbox.c:291
#define mutt_array_size(x)
Definition: memory.h:38
size_t idx
Current position.
Definition: mailbox.c:287
struct Email * arr[10]
Array of Emails to be deleted.
Definition: mailbox.c:286
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_gc_run()

void mailbox_gc_run ( void  )

Run the garbage-collection.

Definition at line 313 of file mailbox.c.

314{
315 for (size_t i = 0; i < GC.idx; i++)
316 {
317 email_free(&GC.arr[i]);
318 }
319 GC.idx = 0;
320}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_get_type_name()

const char * mailbox_get_type_name ( enum MailboxType  type)

Get the type of a Mailbox.

Parameters
typeMailbox type, e.g. MUTT_IMAP
Return values
ptrString describing Mailbox type

Definition at line 327 of file mailbox.c.

328{
329 const char *name = mutt_map_get_name(type, MailboxTypes);
330 if (name)
331 return name;
332 return "UNKNOWN";
333}
static const struct Mapping MailboxTypes[]
Lookups for Mailbox types.
Definition: mailbox.c:40
const char * mutt_map_get_name(int val, const struct Mapping *map)
Lookup a string for a constant.
Definition: mapping.c:42
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ MailboxTypes

const struct Mapping MailboxTypes[]
static
Initial value:
= {
{ "compressed", MUTT_COMPRESSED },
{ "imap", MUTT_IMAP },
{ "maildir", MUTT_MAILDIR },
{ "mbox", MUTT_MBOX },
{ "mh", MUTT_MH },
{ "mmdf", MUTT_MMDF },
{ "nntp", MUTT_NNTP },
{ "notmuch", MUTT_NOTMUCH },
{ "pop", MUTT_POP },
{ NULL, 0 },
}
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition: mailbox.h:51
@ MUTT_MMDF
'mmdf' Mailbox type
Definition: mailbox.h:46
@ MUTT_POP
'POP3' Mailbox type
Definition: mailbox.h:52
@ MUTT_MH
'MH' Mailbox type
Definition: mailbox.h:47
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition: mailbox.h:49
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
@ MUTT_MBOX
'mbox' Mailbox type
Definition: mailbox.h:45
@ MUTT_COMPRESSED
Compressed file Mailbox type.
Definition: mailbox.h:53
@ MUTT_MAILDIR
'Maildir' Mailbox type
Definition: mailbox.h:48

Lookups for Mailbox types.

Definition at line 40 of file mailbox.c.

◆ GC

struct EmailGarbageCollector GC = { 0 }
static

Set of Emails to be deleted.

Definition at line 291 of file mailbox.c.