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 Mailbox *	mailbox_new (void)
	Create a new Mailbox.
void	mailbox_free (struct Mailbox **ptr)
	Free a Mailbox.
struct Mailbox *	mailbox_find (const char *path)
	Find the mailbox with a given path.
struct Mailbox *	mailbox_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

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 mailbox.c.

Function Documentation

mailbox_gen()

int mailbox_gen

(

void

)

Get the next generation number.

Return values

num	Unique number

Definition at line 58 of file mailbox.c.

{
  static int gen = 0;
  return gen++;
}

Here is the caller graph for this function:

mailbox_new()

struct Mailbox * mailbox_new

(

void

)

Create a new Mailbox.

Return values

ptr	New Mailbox

Definition at line 68 of file mailbox.c.

{
  struct Mailbox *m = MUTT_MEM_CALLOC(1, struct Mailbox);
 
  buf_init(&m->pathbuf);
  m->notify = notify_new();
 
  m->email_max = 25;
  m->emails = MUTT_MEM_CALLOC(m->email_max, struct Email *);
  m->v2r = MUTT_MEM_CALLOC(m->email_max, int);
  m->gen = mailbox_gen();
  m->notify_user = true;
  m->poll_new_mail = true;
 
  return m;
}

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]

ptr

Mailbox to free

Definition at line 89 of file mailbox.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Mailbox *m = *ptr;
 
  const bool do_free = (m->opened == 0) && !m->visible;
 
  mutt_debug(LL_DEBUG3, "%sfreeing %s mailbox %s with refcount %d\n",
             do_free ? "" : "not ", m->visible ? "visible" : "invisible",
             buf_string(&m->pathbuf), m->opened);
 
  if (!do_free)
  {
    return;
  }
 
  mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE: %s %p\n",
             mailbox_get_type_name(m->type), (void *) m);
  struct EventMailbox ev_m = { m };
  notify_send(m->notify, NT_MAILBOX, NT_MAILBOX_DELETE, &ev_m);
 
  mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE_ALL\n");
  struct EventEmail ev_e = { 0, NULL };
  notify_send(m->notify, NT_EMAIL, NT_EMAIL_DELETE_ALL, &ev_e);
 
  for (size_t i = 0; i < m->email_max; i++)
    email_free(&m->emails[i]);
 
  m->email_max = 0;
  m->msg_count = 0;
  m->msg_deleted = 0;
  m->msg_flagged = 0;
  m->msg_new = 0;
  m->msg_tagged = 0;
  m->msg_unread = 0;
 
  if (m->mdata_free && m->mdata)
    m->mdata_free(&m->mdata);
 
  buf_dealloc(&m->pathbuf);
  cs_subset_free(&m->sub);
  FREE(&m->name);
  FREE(&m->realpath);
  FREE(&m->emails);
  FREE(&m->v2r);
  notify_free(&m->notify);
  mailbox_gc_run();
 
  /* The NT_MAILBOX_DELETE notification might already have caused *ptr to be NULL,
   * so call free() on the m pointer */
  *ptr = NULL;
  FREE(&m);
}

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

path	Path to match

Return values

ptr	Matching Mailbox

Definition at line 150 of file mailbox.c.

{
  if (!path)
    return NULL;
 
  struct stat st = { 0 };
  struct stat st_tmp = { 0 };
 
  if (stat(path, &st) != 0)
    return NULL;
 
  struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
  neomutt_mailboxlist_get_all(&ml, NeoMutt, MUTT_MAILBOX_ANY);
  struct MailboxNode *np = NULL;
  struct Mailbox *m = NULL;
  STAILQ_FOREACH(np, &ml, entries)
  {
    if ((stat(mailbox_path(np->mailbox), &st_tmp) == 0) &&
        (st.st_dev == st_tmp.st_dev) && (st.st_ino == st_tmp.st_ino))
    {
      m = np->mailbox;
      break;
    }
  }
  neomutt_mailboxlist_clear(&ml);
 
  return m;
}

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

name	Name to match

Return values

ptr	Matching Mailbox
NULL	No matching mailbox found

Note

This searches across all Accounts

Definition at line 187 of file mailbox.c.

{
  if (!name)
    return NULL;
 
  struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
  neomutt_mailboxlist_get_all(&ml, NeoMutt, MUTT_MAILBOX_ANY);
  struct MailboxNode *np = NULL;
  struct Mailbox *m = NULL;
  STAILQ_FOREACH(np, &ml, entries)
  {
    if (mutt_str_equal(np->mailbox->name, name))
    {
      m = np->mailbox;
      break;
    }
  }
  neomutt_mailboxlist_clear(&ml);
 
  return m;
}

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

m	Mailbox to check

Note

Only applies to local Mailboxes

Definition at line 215 of file mailbox.c.

{
  struct stat st = { 0 };
 
  if (!m)
    return;
 
  if (stat(mailbox_path(m), &st) == 0)
    m->size = (off_t) st.st_size;
  else
    m->size = 0;
}

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

m	Mailbox
action	Change to Mailbox

Definition at line 233 of file mailbox.c.

{
  if (!m)
    return;
 
  mutt_debug(LL_NOTIFY, "NT_MAILBOX_CHANGE: %s %p\n",
             mailbox_get_type_name(m->type), (void *) m);
  struct EventMailbox ev_m = { m };
  notify_send(m->notify, NT_MAILBOX, action, &ev_m);
}

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

m	Mailbox
e	Email

Definition at line 249 of file mailbox.c.

{
  m->size += email_size(e);
}

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

m	Mailbox
e	Email

Definition at line 259 of file mailbox.c.

{
  m->size -= email_size(e);
}

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

m	Mailbox
sub	Parent Config Subset

Return values

true

Success

Definition at line 270 of file mailbox.c.

{
  if (!m || m->sub || !sub)
    return false;
 
  m->sub = cs_subset_new(m->name, sub, m->notify);
  m->sub->scope = SET_SCOPE_MAILBOX;
  return true;
}

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

e

Email

Precondition

e is not NULL

Definition at line 298 of file mailbox.c.

{
  ASSERT(e);
  if (GC.idx == mutt_array_size(GC.arr))
  {
    mailbox_gc_run();
  }
  GC.arr[GC.idx] = e;
  GC.idx++;
}

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.

{
  for (size_t i = 0; i < GC.idx; i++)
  {
    email_free(&GC.arr[i]);
  }
  GC.idx = 0;
}

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

type	Mailbox type, e.g. MUTT_IMAP

Return values

ptr	String describing Mailbox type

Definition at line 326 of file mailbox.c.

{
  const char *name = mutt_map_get_name(type, MailboxTypes);
  if (name)
    return name;
  return "UNKNOWN";
}

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 },
  
}

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.