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. More...
void	mutt_mailbox_cleanup (const char *path, struct stat *st)
	Restore the timestamp of a mailbox. More...
bool	mutt_mailbox_list (void)
	List the mailboxes with new mail. More...
struct Mailbox *	mutt_mailbox_next (struct Mailbox *m_cur, struct Buffer *s)
	Incoming folders completion routine. More...
struct Mailbox *	mutt_mailbox_next_unread (struct Mailbox *m_cur, struct Buffer *s)
	Find next mailbox with unread mail. More...
bool	mutt_mailbox_notify (struct Mailbox *m_cur)
	Notify the user if there's new mail. More...
void	mutt_mailbox_set_notified (struct Mailbox *m)
	Note when the user was last notified of new mail. More...

Detailed Description

Mailbox helper functions.

• Richard Russon

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_FORCE

Return values

num	Number of mailboxes with new mail

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

Definition at line 156 of file mutt_mailbox.c.

{
  struct stat st_ctx = { 0 };
  time_t t;
  st_ctx.st_dev = 0;
  st_ctx.st_ino = 0;
 
#ifdef USE_IMAP
  if (flags & MUTT_MAILBOX_CHECK_FORCE)
    mutt_update_num_postponed();
#endif
 
  /* fastest return if there are no mailboxes */
  if (TAILQ_EMPTY(&NeoMutt->accounts))
    return 0;
 
  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");
 
  t = mutt_date_epoch();
  if ((flags == MUTT_MAILBOX_CHECK_NO_FLAGS) && (t - MailboxTime < c_mail_check))
    return MailboxCount;
 
  if ((flags & MUTT_MAILBOX_CHECK_FORCE_STATS) ||
      (c_mail_check_stats && ((t - MailboxStatsTime) >= c_mail_check_stats_interval)))
  {
    flags |= MUTT_MAILBOX_CHECK_FORCE_STATS;
    MailboxStatsTime = t;
  }
 
  MailboxTime = t;
  MailboxCount = 0;
  MailboxNotify = 0;
 
  /* check device ID and serial number instead of comparing paths */
  if (!m_cur || (m_cur->type == MUTT_IMAP) || (m_cur->type == MUTT_POP)
#ifdef USE_NNTP
      || (m_cur->type == MUTT_NNTP)
#endif
      || stat(mailbox_path(m_cur), &st_ctx) != 0)
  {
    st_ctx.st_dev = 0;
    st_ctx.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)
  {
    if (!np->mailbox->visible)
      continue;
 
    CheckStatsFlags m_flags = flags;
    if (!np->mailbox->first_check_stats_done && c_mail_check_stats)
    {
      m_flags |= MUTT_MAILBOX_CHECK_FORCE_STATS;
    }
    mailbox_check(m_cur, np->mailbox, &st_ctx, m_flags);
    if (np->mailbox->has_new)
      MailboxCount++;
    np->mailbox->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:

mutt_mailbox_cleanup()

void mutt_mailbox_cleanup	(	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 424 of file mutt_mailbox.c.

{
#ifdef HAVE_UTIMENSAT
  struct timespec ts[2];
#else
  struct utimbuf ut;
#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_epoch();
      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

)

List the mailboxes with new mail.

Return values

true	There is new mail

Definition at line 243 of file mutt_mailbox.c.

{
  char mailboxlist[512] = { 0 };
  size_t pos = 0;
  int first = 1;
 
  int have_unnotified = MailboxNotify;
 
  struct Buffer *path = mutt_buffer_pool_get();
 
  mailboxlist[0] = '\0';
  pos += strlen(strncat(mailboxlist, _("New mail in "), sizeof(mailboxlist) - 1 - pos));
  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)
  {
    /* Is there new mail in this mailbox? */
    if (!np->mailbox->has_new || (have_unnotified && np->mailbox->notified))
      continue;
 
    mutt_buffer_strcpy(path, mailbox_path(np->mailbox));
    mutt_buffer_pretty_mailbox(path);
 
    const size_t width = msgwin_get_width();
    if (!first && (width >= 7) && ((pos + mutt_buffer_len(path)) >= (width - 7)))
    {
      break;
    }
 
    if (!first)
      pos += strlen(strncat(mailboxlist + pos, ", ", sizeof(mailboxlist) - 1 - pos));
 
    /* Prepend an asterisk to mailboxes not already notified */
    if (!np->mailbox->notified)
    {
      /* pos += strlen (strncat(mailboxlist + pos, "*", sizeof(mailboxlist)-1-pos)); */
      np->mailbox->notified = true;
      MailboxNotify--;
    }
    pos += strlen(strncat(mailboxlist + pos, mutt_buffer_string(path),
                          sizeof(mailboxlist) - 1 - pos));
    first = 0;
  }
  neomutt_mailboxlist_clear(&ml);
 
  if (!first && np)
  {
    strncat(mailboxlist + pos, ", ...", sizeof(mailboxlist) - 1 - pos);
  }
 
  mutt_buffer_pool_release(&path);
 
  if (!first)
  {
    mutt_message("%s", mailboxlist);
    return true;
  }
 
  /* there were no mailboxes needing to be notified, so clean up since
    * MailboxNotify has somehow gotten out of sync */
  MailboxNotify = 0;
  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 378 of file mutt_mailbox.c.

{
  mutt_buffer_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_FORCE); /* mailbox was wrong - resync things */
  }
 
  mutt_buffer_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 404 of file mutt_mailbox.c.

{
  mutt_buffer_expand_path(s);
 
  struct Mailbox *m_res = find_next_mailbox(s, false);
  if (m_res)
    return m_res;
 
  mutt_buffer_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 230 of file mutt_mailbox.c.

{
  if ((mutt_mailbox_check(m_cur, MUTT_MAILBOX_CHECK_NO_FLAGS) > 0) && MailboxNotify)
  {
    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 312 of file mutt_mailbox.c.

{
  if (!m)
    return;
 
  m->notified = true;
#ifdef HAVE_CLOCK_GETTIME
  clock_gettime(CLOCK_REALTIME, &m->last_visited);
#else
  m->last_visited.tv_sec = mutt_date_epoch();
  m->last_visited.tv_nsec = 0;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function: