NeoMutt  2024-11-14-138-ge5ca67
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
mutt_mailbox.h File Reference

Mailbox helper functions. More...

#include <stdbool.h>
#include "core/lib.h"
+ Include dependency graph for mutt_mailbox.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int mutt_mailbox_check (struct Mailbox *m_cur, CheckStatsFlags flags)
 Check all all Mailboxes for new mail.
 
void mailbox_restore_timestamp (const char *path, struct stat *st)
 Restore the timestamp of a mailbox.
 
bool mutt_mailbox_list (void)
 Show a message with the list of mailboxes with new mail.
 
struct Mailboxmutt_mailbox_next (struct Mailbox *m_cur, struct Buffer *s)
 Incoming folders completion routine.
 
struct Mailboxmutt_mailbox_next_unread (struct Mailbox *m_cur, struct Buffer *s)
 Find next mailbox with unread mail.
 
bool mutt_mailbox_notify (struct Mailbox *m_cur)
 Notify the user if there's new mail.
 
void mutt_mailbox_set_notified (struct Mailbox *m)
 Note when the user was last notified of new mail.
 

Detailed Description

Mailbox helper functions.

Authors
  • 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 mutt_mailbox.h.

Function Documentation

◆ mutt_mailbox_check()

int mutt_mailbox_check ( struct Mailbox m_cur,
CheckStatsFlags  flags 
)

Check all all Mailboxes for new mail.

Parameters
m_curCurrent Mailbox
flagsFlags, e.g. MUTT_MAILBOX_CHECK_STATS
Return values
numNumber of mailboxes with new mail

Check all all Mailboxes for new mail and total/new/flagged messages

Definition at line 169 of file mutt_mailbox.c.

170{
171 if (TAILQ_EMPTY(&NeoMutt->accounts)) // fast return if there are no mailboxes
172 return 0;
173
176
177 const short c_mail_check = cs_subset_number(NeoMutt->sub, "mail_check");
178 const bool c_mail_check_stats = cs_subset_bool(NeoMutt->sub, "mail_check_stats");
179 const short c_mail_check_stats_interval = cs_subset_number(NeoMutt->sub, "mail_check_stats_interval");
180
181 time_t t = mutt_date_now();
182 if ((flags == MUTT_MAILBOX_CHECK_NO_FLAGS) && ((t - MailboxTime) < c_mail_check))
183 return MailboxCount;
184
185 if ((flags & MUTT_MAILBOX_CHECK_STATS) ||
186 (c_mail_check_stats && ((t - MailboxStatsTime) >= c_mail_check_stats_interval)))
187 {
190 }
191
192 MailboxTime = t;
193 MailboxCount = 0;
194 MailboxNotify = 0;
195
196 /* check device ID and serial number instead of comparing paths */
197 struct stat st_cur = { 0 };
198 if (!m_cur || (m_cur->type == MUTT_IMAP) || (m_cur->type == MUTT_POP) ||
199 (m_cur->type == MUTT_NNTP) || stat(mailbox_path(m_cur), &st_cur) != 0)
200 {
201 st_cur.st_dev = 0;
202 st_cur.st_ino = 0;
203 }
204
205 struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
207 struct MailboxNode *np = NULL;
208 STAILQ_FOREACH(np, &ml, entries)
209 {
210 struct Mailbox *m = np->mailbox;
211
212 if (!m->visible || !m->poll_new_mail)
213 continue;
214
215 CheckStatsFlags m_flags = flags;
216 if (!m->first_check_stats_done && c_mail_check_stats)
217 {
218 m_flags |= MUTT_MAILBOX_CHECK_STATS;
219 }
220 mailbox_check(m_cur, m, &st_cur, m_flags);
221 if (m->has_new)
222 MailboxCount++;
223 m->first_check_stats_done = true;
224 }
226
227 return MailboxCount;
228}
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:143
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:223
@ MUTT_POP
'POP3' Mailbox type
Definition: mailbox.h:52
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition: mailbox.h:49
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
@ MUTT_MAILBOX_ANY
Match any Mailbox type.
Definition: mailbox.h:42
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:456
static time_t MailboxStatsTime
last time we check performed mail_check_stats
Definition: mutt_mailbox.c:45
static short MailboxCount
how many boxes with new mail
Definition: mutt_mailbox.c:46
static short MailboxNotify
Definition: mutt_mailbox.c:47
static void mailbox_check(struct Mailbox *m_cur, struct Mailbox *m_check, struct stat *st_cur, CheckStatsFlags flags)
Check a mailbox for new mail.
Definition: mutt_mailbox.c:83
static time_t MailboxTime
last time we started checking for mail
Definition: mutt_mailbox.c:44
#define MUTT_MAILBOX_CHECK_NO_FLAGS
No flags are set.
Definition: mxapi.h:53
#define MUTT_MAILBOX_CHECK_STATS
Ignore mail_check_stats and calculate statistics (used by <check-stats>)
Definition: mxapi.h:55
#define MUTT_MAILBOX_CHECK_POSTPONED
Make sure the number of postponed messages is updated.
Definition: mxapi.h:54
uint8_t CheckStatsFlags
Flags for mutt_mailbox_check.
Definition: mxapi.h:52
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
void mutt_update_num_postponed(void)
Force the update of the number of postponed messages.
Definition: postpone.c:177
#define STAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define TAILQ_EMPTY(head)
Definition: queue.h:739
List of Mailboxes.
Definition: mailbox.h:166
struct Mailbox * mailbox
Mailbox in the list.
Definition: mailbox.h:167
A mailbox.
Definition: mailbox.h:79
bool has_new
Mailbox has new mail.
Definition: mailbox.h:85
bool first_check_stats_done
True when the check have been done at least one time.
Definition: mailbox.h:112
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
bool poll_new_mail
Check for new mail.
Definition: mailbox.h:115
bool visible
True if a result of "mailboxes".
Definition: mailbox.h:130
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct AccountList accounts
List of all Accounts.
Definition: neomutt.h:47
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailbox_restore_timestamp()

void mailbox_restore_timestamp ( const char *  path,
struct stat *  st 
)

Restore the timestamp of a mailbox.

Parameters
pathPath to the mailbox
stTimestamp info from stat()

Fix up the atime and mtime after mbox/mmdf mailbox was modified according to stat() info taken before a modification.

Definition at line 407 of file mutt_mailbox.c.

408{
409#ifdef HAVE_UTIMENSAT
410 struct timespec ts[2] = { { 0 }, { 0 } };
411#else
412 struct utimbuf ut = { 0 };
413#endif
414
415 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
416 if (c_check_mbox_size)
417 {
418 struct Mailbox *m = mailbox_find(path);
419 if (m && !m->has_new)
421 }
422 else
423 {
424 /* fix up the times so mailbox won't get confused */
425 if (st->st_mtime > st->st_atime)
426 {
427#ifdef HAVE_UTIMENSAT
428 ts[0].tv_sec = 0;
429 ts[0].tv_nsec = UTIME_OMIT;
430 ts[1].tv_sec = 0;
431 ts[1].tv_nsec = UTIME_NOW;
432 utimensat(AT_FDCWD, buf, ts, 0);
433#else
434 ut.actime = st->st_atime;
435 ut.modtime = mutt_date_now();
436 utime(path, &ut);
437#endif
438 }
439 else
440 {
441#ifdef HAVE_UTIMENSAT
442 ts[0].tv_sec = 0;
443 ts[0].tv_nsec = UTIME_NOW;
444 ts[1].tv_sec = 0;
445 ts[1].tv_nsec = UTIME_NOW;
446 utimensat(AT_FDCWD, buf, ts, 0);
447#else
448 utime(path, NULL);
449#endif
450 }
451 }
452}
void mailbox_update(struct Mailbox *m)
Get the mailbox's current size.
Definition: mailbox.c:215
struct Mailbox * mailbox_find(const char *path)
Find the mailbox with a given path.
Definition: mailbox.c:150
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_mailbox_list()

bool mutt_mailbox_list ( void  )

Show a message with the list of mailboxes with new mail.

Return values
trueThere is new mail

Definition at line 248 of file mutt_mailbox.c.

249{
250 int have_unnotified = MailboxNotify;
251
252 struct Buffer *path = buf_pool_get();
253 struct Buffer *mailboxlist = buf_pool_get();
254
255 buf_addstr(mailboxlist, _("New mail in "));
256 struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
258 struct MailboxNode *np = NULL;
259 bool any_new = false;
260 STAILQ_FOREACH(np, &ml, entries)
261 {
262 /* Is there new mail in this mailbox? */
263 if (!np->mailbox->has_new || (have_unnotified && np->mailbox->notified))
264 continue;
265
266 buf_strcpy(path, mailbox_path(np->mailbox));
267 buf_pretty_mailbox(path);
268
269 if (any_new)
270 {
271 buf_addstr(mailboxlist, ", ");
272 }
273
274 if (!np->mailbox->notified)
275 {
276 np->mailbox->notified = true;
278 }
279 buf_addstr(mailboxlist, buf_string(path));
280 any_new = true;
281 }
283
284 buf_pool_release(&path);
285
286 if (any_new)
287 {
288 mutt_message("%s", buf_string(mailboxlist));
289 buf_pool_release(&mailboxlist);
290 return true;
291 }
292
293 /* there were no mailboxes needing to be notified, so clean up since
294 * MailboxNotify has somehow gotten out of sync */
295 MailboxNotify = 0;
296 buf_pool_release(&mailboxlist);
297 return false;
298}
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:226
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
#define mutt_message(...)
Definition: logging2.h:91
#define _(a)
Definition: message.h:28
void buf_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:519
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:96
String manipulation buffer.
Definition: buffer.h:36
bool notified
User has been notified.
Definition: mailbox.h:101
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_mailbox_next()

struct Mailbox * mutt_mailbox_next ( struct Mailbox m_cur,
struct Buffer s 
)

Incoming folders completion routine.

Parameters
m_curCurrent Mailbox
sBuffer containing name of current mailbox
Return values
ptrMailbox

Given a folder name, find the next incoming folder with new mail. The Mailbox will be returned and a pretty version of the path put into s.

Definition at line 361 of file mutt_mailbox.c.

362{
364
366 {
367 struct Mailbox *m_res = find_next_mailbox(s, true);
368 if (m_res)
369 return m_res;
370
372 }
373
374 buf_reset(s); // no folders with new mail
375 return NULL;
376}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:76
int mutt_mailbox_check(struct Mailbox *m_cur, CheckStatsFlags flags)
Check all all Mailboxes for new mail.
Definition: mutt_mailbox.c:169
static struct Mailbox * find_next_mailbox(struct Buffer *s, bool find_new)
Find the next mailbox with new or unread mail.
Definition: mutt_mailbox.c:322
void buf_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:315
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_mailbox_next_unread()

struct Mailbox * mutt_mailbox_next_unread ( struct Mailbox m_cur,
struct Buffer s 
)

Find next mailbox with unread mail.

Parameters
m_curCurrent Mailbox
sBuffer containing name of current mailbox
Return values
ptrMailbox

Given a folder name, find the next mailbox with unread mail. The Mailbox will be returned and a pretty version of the path put into s.

Definition at line 387 of file mutt_mailbox.c.

388{
390
391 struct Mailbox *m_res = find_next_mailbox(s, false);
392 if (m_res)
393 return m_res;
394
395 buf_reset(s); // no folders with new mail
396 return NULL;
397}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_mailbox_notify()

bool mutt_mailbox_notify ( struct Mailbox m_cur)

Notify the user if there's new mail.

Parameters
m_curCurrent Mailbox
Return values
trueThere is new mail

Definition at line 235 of file mutt_mailbox.c.

236{
238 {
239 return mutt_mailbox_list();
240 }
241 return false;
242}
bool mutt_mailbox_list(void)
Show a message with the list of mailboxes with new mail.
Definition: mutt_mailbox.c:248
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_mailbox_set_notified()

void mutt_mailbox_set_notified ( struct Mailbox m)

Note when the user was last notified of new mail.

Parameters
mMailbox

Definition at line 304 of file mutt_mailbox.c.

305{
306 if (!m)
307 return;
308
309 m->notified = true;
311}
void mutt_time_now(struct timespec *tp)
Set the provided time field to the current time.
Definition: date.c:480
struct timespec last_visited
Time of last exit from this mailbox.
Definition: mailbox.h:104
+ Here is the call graph for this function:
+ Here is the caller graph for this function: