#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#include <time.h>
#include "mutt/lib.h"

Include dependency graph for mailbox.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Mailbox
	A mailbox. More...

struct	MailboxNode
	List of Mailboxes. More...

struct	EventMailbox
	An Event that happened to a Mailbox. More...

Macros
#define	MB_NORMAL 0

#define	MB_HIDDEN 1

#define	MUTT_ACL_NO_FLAGS 0
	No flags are set. More...

#define	MUTT_ACL_ADMIN (1 << 0)
	Administer the account (get/set permissions) More...

#define	MUTT_ACL_CREATE (1 << 1)
	Create a mailbox. More...

#define	MUTT_ACL_DELETE (1 << 2)
	Delete a message. More...

#define	MUTT_ACL_DELMX (1 << 3)
	Delete a mailbox. More...

#define	MUTT_ACL_EXPUNGE (1 << 4)
	Expunge messages. More...

#define	MUTT_ACL_INSERT (1 << 5)
	Add/copy into the mailbox (used when editing a message) More...

#define	MUTT_ACL_LOOKUP (1 << 6)
	Lookup mailbox (visible to 'list') More...

#define	MUTT_ACL_POST (1 << 7)
	Post (submit messages to the server) More...

#define	MUTT_ACL_READ (1 << 8)
	Read the mailbox. More...

#define	MUTT_ACL_SEEN (1 << 9)
	Change the 'seen' status of a message. More...

#define	MUTT_ACL_WRITE (1 << 10)
	Write to a message (for flagging or linking threads) More...

#define	MUTT_ACL_ALL ((1 << 11) - 1)

Typedefs
typedef uint16_t	AclFlags
	ACL Rights - These show permission to... More...

Enumerations
enum	MailboxType { MUTT_MAILBOX_ANY = -2, MUTT_MAILBOX_ERROR = -1, MUTT_UNKNOWN = 0, MUTT_MBOX, MUTT_MMDF, MUTT_MH, MUTT_MAILDIR, MUTT_NNTP, MUTT_IMAP, MUTT_NOTMUCH, MUTT_POP, MUTT_COMPRESSED }
	Supported mailbox formats. More...

enum	NotifyMailbox { NT_MAILBOX_ADD = 1, NT_MAILBOX_REMOVE, NT_MAILBOX_CHANGED, NT_MAILBOX_CLOSED, NT_MAILBOX_INVALID, NT_MAILBOX_RESORT, NT_MAILBOX_SWITCH, NT_MAILBOX_UPDATE, NT_MAILBOX_UNTAG }
	Types of Mailbox Event. More...

Functions
	STAILQ_HEAD (MailboxList, MailboxNode)

void	mailbox_changed (struct Mailbox *m, enum NotifyMailbox action)
	Notify observers of a change to a Mailbox. More...

struct Mailbox *	mailbox_find (const char *path)
	Find the mailbox with a given path. More...

struct Mailbox *	mailbox_find_name (const char *name)
	Find the mailbox with a given name. More...

void	mailbox_free (struct Mailbox **ptr)
	Free a Mailbox. More...

int	mailbox_gen (void)
	Get the next generation number. More...

struct Mailbox *	mailbox_new (void)
	Create a new Mailbox. More...

bool	mailbox_set_subset (struct Mailbox m, struct ConfigSubset sub)
	Set a Mailbox's Config Subset. More...

void	mailbox_size_add (struct Mailbox m, const struct Email e)
	Add an email's size to the total size of a Mailbox. More...

void	mailbox_size_sub (struct Mailbox m, const struct Email e)
	Subtract an email's size from the total size of a Mailbox. More...

void	mailbox_update (struct Mailbox *m)
	Get the mailbox's current size. More...

void	mailbox_gc_add (struct Email *e)
	Add an Email to the garbage-collection set. More...

void	mailbox_gc_run (void)

static const char *	mailbox_path (const struct Mailbox *m)
	Get the Mailbox's path string. More...

Detailed Description

Representation of a mailbox

Authors

Michael R. Elkins
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 mailbox.h.

Macro Definition Documentation

◆ MB_NORMAL

#define MB_NORMAL 0

Definition at line 37 of file mailbox.h.

◆ MB_HIDDEN

#define MB_HIDDEN 1

Definition at line 38 of file mailbox.h.

◆ MUTT_ACL_NO_FLAGS

#define MUTT_ACL_NO_FLAGS 0

No flags are set.

Definition at line 63 of file mailbox.h.

◆ MUTT_ACL_ADMIN

#define MUTT_ACL_ADMIN (1 << 0)

Administer the account (get/set permissions)

Definition at line 64 of file mailbox.h.

◆ MUTT_ACL_CREATE

#define MUTT_ACL_CREATE (1 << 1)

Create a mailbox.

Definition at line 65 of file mailbox.h.

◆ MUTT_ACL_DELETE

#define MUTT_ACL_DELETE (1 << 2)

Delete a message.

Definition at line 66 of file mailbox.h.

◆ MUTT_ACL_DELMX

#define MUTT_ACL_DELMX (1 << 3)

Delete a mailbox.

Definition at line 67 of file mailbox.h.

◆ MUTT_ACL_EXPUNGE

#define MUTT_ACL_EXPUNGE (1 << 4)

Expunge messages.

Definition at line 68 of file mailbox.h.

◆ MUTT_ACL_INSERT

#define MUTT_ACL_INSERT (1 << 5)

Add/copy into the mailbox (used when editing a message)

Definition at line 69 of file mailbox.h.

◆ MUTT_ACL_LOOKUP

#define MUTT_ACL_LOOKUP (1 << 6)

Lookup mailbox (visible to 'list')

Definition at line 70 of file mailbox.h.

◆ MUTT_ACL_POST

#define MUTT_ACL_POST (1 << 7)

Post (submit messages to the server)

Definition at line 71 of file mailbox.h.

◆ MUTT_ACL_READ

#define MUTT_ACL_READ (1 << 8)

Read the mailbox.

Definition at line 72 of file mailbox.h.

◆ MUTT_ACL_SEEN

#define MUTT_ACL_SEEN (1 << 9)

Change the 'seen' status of a message.

Definition at line 73 of file mailbox.h.

◆ MUTT_ACL_WRITE

#define MUTT_ACL_WRITE (1 << 10)

Write to a message (for flagging or linking threads)

Definition at line 74 of file mailbox.h.

◆ MUTT_ACL_ALL

#define MUTT_ACL_ALL ((1 << 11) - 1)

Definition at line 76 of file mailbox.h.

Typedef Documentation

◆ AclFlags

typedef uint16_t AclFlags

ACL Rights - These show permission to...

Flags, e.g. MUTT_ACL_ADMIN

Definition at line 62 of file mailbox.h.

Enumeration Type Documentation

◆ MailboxType

enum MailboxType

Supported mailbox formats.

Enumerator
MUTT_MAILBOX_ANY	Match any Mailbox type.
MUTT_MAILBOX_ERROR	Error occurred examining Mailbox.
MUTT_UNKNOWN	Mailbox wasn't recognised.
MUTT_MBOX	'mbox' Mailbox type
MUTT_MMDF	'mmdf' Mailbox type
MUTT_MH	'MH' Mailbox type
MUTT_MAILDIR	'Maildir' Mailbox type
MUTT_NNTP	'NNTP' (Usenet) Mailbox type
MUTT_IMAP	'IMAP' Mailbox type
MUTT_NOTMUCH	'Notmuch' (virtual) Mailbox type
MUTT_POP	'POP3' Mailbox type
MUTT_COMPRESSED	Compressed file Mailbox type.

Definition at line 43 of file mailbox.h.

 {
   MUTT_MAILBOX_ANY = -2,   
   MUTT_MAILBOX_ERROR = -1, 
   MUTT_UNKNOWN = 0,        
   MUTT_MBOX,               
   MUTT_MMDF,               
   MUTT_MH,                 
   MUTT_MAILDIR,            
   MUTT_NNTP,               
   MUTT_IMAP,               
   MUTT_NOTMUCH,            
   MUTT_POP,                
   MUTT_COMPRESSED,         
 };

◆ NotifyMailbox

enum NotifyMailbox

Types of Mailbox Event.

Observers of NT_MAILBOX will be passed an EventMailbox.

Enumerator
NT_MAILBOX_ADD	A new Mailbox has been created.
NT_MAILBOX_REMOVE	A Mailbox is about to be destroyed.
NT_MAILBOX_CHANGED	Mailbox data has changed.
NT_MAILBOX_CLOSED	Mailbox was closed.
NT_MAILBOX_INVALID	Email list was changed.
NT_MAILBOX_RESORT	Email list needs resorting.
NT_MAILBOX_SWITCH	Current Mailbox has changed.
NT_MAILBOX_UPDATE	Update internal tables.
NT_MAILBOX_UNTAG	Clear the 'last-tagged' pointer.

Definition at line 164 of file mailbox.h.

 {
   NT_MAILBOX_ADD = 1, 
   NT_MAILBOX_REMOVE,  
   NT_MAILBOX_CHANGED, 
  
   /* These don't really belong here as they are tied to GUI operations.
    * Eventually, they'll be eliminated. */
   NT_MAILBOX_CLOSED,  
   NT_MAILBOX_INVALID, 
   NT_MAILBOX_RESORT,  
   NT_MAILBOX_SWITCH,  
   NT_MAILBOX_UPDATE,  
   NT_MAILBOX_UNTAG,   
 };

Function Documentation

◆ STAILQ_HEAD()

STAILQ_HEAD	(	MailboxList	,
		MailboxNode
	)

◆ 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 186 of file mailbox.c.

 {
   if (!m)
     return;
  
   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_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 103 of file mailbox.c.

 {
   if (!path)
     return NULL;
  
   struct stat sb;
   struct stat tmp_sb;
  
   if (stat(path, &sb) != 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), &tmp_sb) == 0) &&
         (sb.st_dev == tmp_sb.st_dev) && (sb.st_ino == tmp_sb.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 140 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_free()

void mailbox_free ( struct Mailbox ** ptr )

Free a Mailbox.

Parameters

[out] ptr Mailbox to free

Definition at line 71 of file mailbox.c.

 {
   if (!ptr || !*ptr)
     return;
  
   struct Mailbox *m = *ptr;
  
   mailbox_changed(m, NT_MAILBOX_CLOSED);
  
   if (m->mdata && m->mdata_free)
     m->mdata_free(&m->mdata);
  
   for (size_t i = 0; i < m->email_max; i++)
     email_free(&m->emails[i]);
  
   mutt_buffer_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();
  
   FREE(ptr);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailbox_gen()

int mailbox_gen ( void )

Get the next generation number.

Definition at line 42 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 52 of file mailbox.c.

 {
   struct Mailbox *m = mutt_mem_calloc(1, sizeof(struct Mailbox));
  
   mutt_buffer_init(&m->pathbuf);
   m->notify = notify_new();
  
   m->email_max = 25;
   m->emails = mutt_mem_calloc(m->email_max, sizeof(struct Email *));
   m->v2r = mutt_mem_calloc(m->email_max, sizeof(int));
   m->gen = mailbox_gen();
  
   return m;
 }

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 221 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_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 200 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 210 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_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 168 of file mailbox.c.

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

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 != NULL

Definition at line 242 of file mailbox.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailbox_gc_run()

void mailbox_gc_run ( void )

Definition at line 255 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_path()

static const char* mailbox_path ( const struct Mailbox * m )

inlinestatic

Get the Mailbox's path string.

Parameters

m Mailbox

Return values

ptr	Path string

Definition at line 206 of file mailbox.h.

 {
   return mutt_buffer_string(&m->pathbuf); // LCOV_EXCL_LINE
 }

Here is the call graph for this function:

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ MB_NORMAL

◆ MB_HIDDEN

◆ MUTT_ACL_NO_FLAGS

◆ MUTT_ACL_ADMIN

◆ MUTT_ACL_CREATE

◆ MUTT_ACL_DELETE

◆ MUTT_ACL_DELMX

◆ MUTT_ACL_EXPUNGE

◆ MUTT_ACL_INSERT

◆ MUTT_ACL_LOOKUP

◆ MUTT_ACL_POST

◆ MUTT_ACL_READ

◆ MUTT_ACL_SEEN

◆ MUTT_ACL_WRITE

◆ MUTT_ACL_ALL

Typedef Documentation

◆ AclFlags

Enumeration Type Documentation

◆ MailboxType

◆ NotifyMailbox

Function Documentation

◆ STAILQ_HEAD()

◆ mailbox_changed()

◆ mailbox_find()

◆ mailbox_find_name()

◆ mailbox_free()

◆ mailbox_gen()

◆ mailbox_new()

◆ mailbox_set_subset()

◆ mailbox_size_add()

◆ mailbox_size_sub()

◆ mailbox_update()

◆ mailbox_gc_add()

◆ mailbox_gc_run()

◆ mailbox_path()