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 Mailbox *	mutt_mailbox_next (struct Mailbox *m_cur, struct Buffer *s)
	Incoming folders completion routine.
struct Mailbox *	mutt_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

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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_cur	Current Mailbox
flags	Flags, e.g. MUTT_MAILBOX_CHECK_STATS

Return values

num	Number 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.

{
  if (TAILQ_EMPTY(&NeoMutt->accounts)) // fast return if there are no mailboxes
    return 0;
 
  if (flags & MUTT_MAILBOX_CHECK_POSTPONED)
    mutt_update_num_postponed();
 
  const short c_mail_check = cs_subset_number(NeoMutt->sub, "mail_check");
  const bool c_mail_check_stats = cs_subset_bool(NeoMutt->sub, "mail_check_stats");
  const short c_mail_check_stats_interval = cs_subset_number(NeoMutt->sub, "mail_check_stats_interval");
 
  time_t t = mutt_date_now();
  if ((flags == MUTT_MAILBOX_CHECK_NO_FLAGS) && ((t - MailboxTime) < c_mail_check))
    return MailboxCount;
 
  if ((flags & MUTT_MAILBOX_CHECK_STATS) ||
      (c_mail_check_stats && ((t - MailboxStatsTime) >= c_mail_check_stats_interval)))
  {
    flags |= MUTT_MAILBOX_CHECK_STATS;
    MailboxStatsTime = t;
  }
 
  MailboxTime = t;
  MailboxCount = 0;
  MailboxNotify = 0;
 
  /* check device ID and serial number instead of comparing paths */
  struct stat st_cur = { 0 };
  if (!m_cur || (m_cur->type == MUTT_IMAP) || (m_cur->type == MUTT_POP) ||
      (m_cur->type == MUTT_NNTP) || stat(mailbox_path(m_cur), &st_cur) != 0)
  {
    st_cur.st_dev = 0;
    st_cur.st_ino = 0;
  }
 
  struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
  neomutt_mailboxlist_get_all(&ml, NeoMutt, MUTT_MAILBOX_ANY);
  struct MailboxNode *np = NULL;
  STAILQ_FOREACH(np, &ml, entries)
  {
    struct Mailbox *m = np->mailbox;
 
    if (!m->visible || !m->poll_new_mail)
      continue;
 
    CheckStatsFlags m_flags = flags;
    if (!m->first_check_stats_done && c_mail_check_stats)
    {
      m_flags |= MUTT_MAILBOX_CHECK_STATS;
    }
    mailbox_check(m_cur, m, &st_cur, m_flags);
    if (m->has_new)
      MailboxCount++;
    m->first_check_stats_done = true;
  }
  neomutt_mailboxlist_clear(&ml);
 
  return MailboxCount;
}

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

path	Path to the mailbox
st	Timestamp 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.

{
#ifdef HAVE_UTIMENSAT
  struct timespec ts[2] = { { 0 }, { 0 } };
#else
  struct utimbuf ut = { 0 };
#endif
 
  const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
  if (c_check_mbox_size)
  {
    struct Mailbox *m = mailbox_find(path);
    if (m && !m->has_new)
      mailbox_update(m);
  }
  else
  {
    /* fix up the times so mailbox won't get confused */
    if (st->st_mtime > st->st_atime)
    {
#ifdef HAVE_UTIMENSAT
      ts[0].tv_sec = 0;
      ts[0].tv_nsec = UTIME_OMIT;
      ts[1].tv_sec = 0;
      ts[1].tv_nsec = UTIME_NOW;
      utimensat(AT_FDCWD, buf, ts, 0);
#else
      ut.actime = st->st_atime;
      ut.modtime = mutt_date_now();
      utime(path, &ut);
#endif
    }
    else
    {
#ifdef HAVE_UTIMENSAT
      ts[0].tv_sec = 0;
      ts[0].tv_nsec = UTIME_NOW;
      ts[1].tv_sec = 0;
      ts[1].tv_nsec = UTIME_NOW;
      utimensat(AT_FDCWD, buf, ts, 0);
#else
      utime(path, NULL);
#endif
    }
  }
}

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

true	There is new mail

Definition at line 248 of file mutt_mailbox.c.

{
  int have_unnotified = MailboxNotify;
 
  struct Buffer *path = buf_pool_get();
  struct Buffer *mailboxlist = buf_pool_get();
 
  buf_addstr(mailboxlist, _("New mail in "));
  struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
  neomutt_mailboxlist_get_all(&ml, NeoMutt, MUTT_MAILBOX_ANY);
  struct MailboxNode *np = NULL;
  bool any_new = false;
  STAILQ_FOREACH(np, &ml, entries)
  {
    /* Is there new mail in this mailbox? */
    if (!np->mailbox->has_new || (have_unnotified && np->mailbox->notified))
      continue;
 
    buf_strcpy(path, mailbox_path(np->mailbox));
    buf_pretty_mailbox(path);
 
    if (any_new)
    {
      buf_addstr(mailboxlist, ", ");
    }
 
    if (!np->mailbox->notified)
    {
      np->mailbox->notified = true;
      MailboxNotify--;
    }
    buf_addstr(mailboxlist, buf_string(path));
    any_new = true;
  }
  neomutt_mailboxlist_clear(&ml);
 
  buf_pool_release(&path);
 
  if (any_new)
  {
    mutt_message("%s", buf_string(mailboxlist));
    buf_pool_release(&mailboxlist);
    return true;
  }
 
  /* there were no mailboxes needing to be notified, so clean up since
    * MailboxNotify has somehow gotten out of sync */
  MailboxNotify = 0;
  buf_pool_release(&mailboxlist);
  return false;
}

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_cur	Current Mailbox
s	Buffer containing name of current mailbox

Return values

ptr

Mailbox

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.

{
  buf_expand_path(s);
 
  if (mutt_mailbox_check(m_cur, MUTT_MAILBOX_CHECK_NO_FLAGS) > 0)
  {
    struct Mailbox *m_res = find_next_mailbox(s, true);
    if (m_res)
      return m_res;
 
    mutt_mailbox_check(m_cur, MUTT_MAILBOX_CHECK_POSTPONED);
  }
 
  buf_reset(s); // no folders with new mail
  return NULL;
}

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_cur	Current Mailbox
s	Buffer containing name of current mailbox

Return values

ptr

Mailbox

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.

{
  buf_expand_path(s);
 
  struct Mailbox *m_res = find_next_mailbox(s, false);
  if (m_res)
    return m_res;
 
  buf_reset(s); // no folders with new mail
  return NULL;
}

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_cur

Current Mailbox

Return values

true	There is new mail

Definition at line 235 of file mutt_mailbox.c.

{
  if ((mutt_mailbox_check(m_cur, MUTT_MAILBOX_CHECK_NO_FLAGS) > 0) && (MailboxNotify != 0))
  {
    return mutt_mailbox_list();
  }
  return false;
}

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

m

Mailbox

Definition at line 304 of file mutt_mailbox.c.

{
  if (!m)
    return;
 
  m->notified = true;
  mutt_time_now(&m->last_visited);
}

Here is the call graph for this function:

Here is the caller graph for this function: