NeoMutt  2024-04-25-97-g7d2481
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
mailbox.c File Reference

Representation of a mailbox. More...

#include "config.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 58 of file mailbox.c.

59{
60 static int gen = 0;
61 return gen++;
62}
+ 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 68 of file mailbox.c.

69{
70 struct Mailbox *m = mutt_mem_calloc(1, sizeof(struct Mailbox));
71
72 buf_init(&m->pathbuf);
73 m->notify = notify_new();
74
75 m->email_max = 25;
76 m->emails = mutt_mem_calloc(m->email_max, sizeof(struct Email *));
77 m->v2r = mutt_mem_calloc(m->email_max, sizeof(int));
78 m->gen = mailbox_gen();
79 m->notify_user = true;
80 m->poll_new_mail = true;
81
82 return m;
83}
struct Buffer * buf_init(struct Buffer *buf)
Initialise a new Buffer.
Definition: buffer.c:61
int mailbox_gen(void)
Get the next generation number.
Definition: mailbox.c:58
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
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 89 of file mailbox.c.

90{
91 if (!ptr || !*ptr)
92 return;
93
94 struct Mailbox *m = *ptr;
95
96 const bool do_free = (m->opened == 0) && !m->visible;
97
98 mutt_debug(LL_DEBUG3, "%sfreeing %s mailbox %s with refcount %d\n",
99 do_free ? "" : "not ", m->visible ? "visible" : "invisible",
100 buf_string(&m->pathbuf), m->opened);
101
102 if (!do_free)
103 {
104 return;
105 }
106
107 mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE: %s %p\n",
108 mailbox_get_type_name(m->type), (void *) m);
109 struct EventMailbox ev_m = { m };
111
112 mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE_ALL\n");
113 struct EventEmail ev_e = { 0, NULL };
115
116 for (size_t i = 0; i < m->email_max; i++)
117 email_free(&m->emails[i]);
118
119 m->email_max = 0;
120 m->msg_count = 0;
121 m->msg_deleted = 0;
122 m->msg_flagged = 0;
123 m->msg_new = 0;
124 m->msg_tagged = 0;
125 m->msg_unread = 0;
126
127 if (m->mdata_free && m->mdata)
128 m->mdata_free(&m->mdata);
129
130 buf_dealloc(&m->pathbuf);
131 cs_subset_free(&m->sub);
132 FREE(&m->name);
133 FREE(&m->realpath);
134 FREE(&m->emails);
135 FREE(&m->v2r);
136 notify_free(&m->notify);
138
139 /* The NT_MAILBOX_DELETE notification might already have caused *ptr to be NULL,
140 * so call free() on the m pointer */
141 *ptr = NULL;
142 FREE(&m);
143}
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:377
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:312
const char * mailbox_get_type_name(enum MailboxType type)
Get the type of a Mailbox.
Definition: mailbox.c:326
@ 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:185
#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:196
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 150 of file mailbox.c.

151{
152 if (!path)
153 return NULL;
154
155 struct stat st = { 0 };
156 struct stat st_tmp = { 0 };
157
158 if (stat(path, &st) != 0)
159 return NULL;
160
161 struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
163 struct MailboxNode *np = NULL;
164 struct Mailbox *m = NULL;
165 STAILQ_FOREACH(np, &ml, entries)
166 {
167 if ((stat(mailbox_path(np->mailbox), &st_tmp) == 0) &&
168 (st.st_dev == st_tmp.st_dev) && (st.st_ino == st_tmp.st_ino))
169 {
170 m = np->mailbox;
171 break;
172 }
173 }
175
176 return m;
177}
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:168
size_t neomutt_mailboxlist_get_all(struct MailboxList *head, struct NeoMutt *n, enum MailboxType type)
Get a List of all Mailboxes.
Definition: neomutt.c:191
#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:42
+ 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 187 of file mailbox.c.

188{
189 if (!name)
190 return NULL;
191
192 struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
194 struct MailboxNode *np = NULL;
195 struct Mailbox *m = NULL;
196 STAILQ_FOREACH(np, &ml, entries)
197 {
198 if (mutt_str_equal(np->mailbox->name, name))
199 {
200 m = np->mailbox;
201 break;
202 }
203 }
205
206 return m;
207}
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
+ 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 215 of file mailbox.c.

216{
217 struct stat st = { 0 };
218
219 if (!m)
220 return;
221
222 if (stat(mailbox_path(m), &st) == 0)
223 m->size = (off_t) st.st_size;
224 else
225 m->size = 0;
226}
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 233 of file mailbox.c.

234{
235 if (!m)
236 return;
237
238 mutt_debug(LL_NOTIFY, "NT_MAILBOX_CHANGE: %s %p\n",
239 mailbox_get_type_name(m->type), (void *) m);
240 struct EventMailbox ev_m = { m };
241 notify_send(m->notify, NT_MAILBOX, action, &ev_m);
242}
+ 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 249 of file mailbox.c.

250{
251 m->size += email_size(e);
252}
size_t email_size(const struct Email *e)
Compute the size of an email.
Definition: email.c:121
+ 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 259 of file mailbox.c.

260{
261 m->size -= email_size(e);
262}
+ 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 270 of file mailbox.c.

271{
272 if (!m || m->sub || !sub)
273 return false;
274
275 m->sub = cs_subset_new(m->name, sub, m->notify);
277 return true;
278}
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 298 of file mailbox.c.

299{
300 ASSERT(e);
301 if (GC.idx == mutt_array_size(GC.arr))
302 {
304 }
305 GC.arr[GC.idx] = e;
306 GC.idx++;
307}
static struct EmailGarbageCollector GC
Set of Emails to be deleted.
Definition: mailbox.c:290
#define mutt_array_size(x)
Definition: memory.h:38
#define ASSERT(COND)
Definition: signal2.h:58
size_t idx
Current position.
Definition: mailbox.c:286
struct Email * arr[10]
Array of Emails to be deleted.
Definition: mailbox.c:285
+ 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 312 of file mailbox.c.

313{
314 for (size_t i = 0; i < GC.idx; i++)
315 {
316 email_free(&GC.arr[i]);
317 }
318 GC.idx = 0;
319}
+ 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 326 of file mailbox.c.

327{
328 const char *name = mutt_map_get_name(type, MailboxTypes);
329 if (name)
330 return name;
331 return "UNKNOWN";
332}
static const struct Mapping MailboxTypes[]
Lookups for Mailbox types.
Definition: mailbox.c:39
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 39 of file mailbox.c.

◆ GC

struct EmailGarbageCollector GC = { 0 }
static

Set of Emails to be deleted.

Definition at line 290 of file mailbox.c.