module.c File Reference

Definition of the Maildir Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	maildir_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	maildir_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	maildir_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	MaildirVars []
	Config definitions for the Maildir library.
struct ConfigDef	MaildirVarsHcache []
	Config definitions for the Maildir header cache.
const struct Module	ModuleMaildir
	Module for the Maildir library.

Detailed Description

Definition of the Maildir Module.

Authors

• 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 module.c.

Function Documentation

maildir_init()

static bool maildir_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 43 of file module.c.

{
  struct MaildirModuleData *mod_data = MUTT_MEM_CALLOC(1, struct MaildirModuleData);
  neomutt_set_module_data(n, MODULE_ID_MAILDIR, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

maildir_config_define_variables()

static bool maildir_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 57 of file module.c.

{
  bool rc = cs_register_variables(cs, MaildirVars);
 
#if defined(USE_HCACHE)
  rc |= cs_register_variables(cs, MaildirVarsHcache);
#endif
 
  return rc;
}

Here is the call graph for this function:

maildir_cleanup()

static bool maildir_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 71 of file module.c.

{
  struct MaildirModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

MaildirVars

struct ConfigDef MaildirVars[]

extern

Config definitions for the Maildir library.

Definition at line 68 of file config.c.

                                 {
  // clang-format off
  { "check_new", DT_BOOL, true, 0, NULL,
    "(maildir,mh) Check for new mail while the mailbox is open"
  },
  { "maildir_check_cur", DT_BOOL, false, 0, NULL,
    "Check both 'new' and 'cur' directories for new mail"
  },
  { "maildir_field_delimiter", DT_STRING|D_NOT_EMPTY|D_ON_STARTUP, IP ":", 0, maildir_field_delimiter_validator,
    "Field delimiter to be used for maildir email files (default is colon, recommended alternative is semi-colon)"
  },
  { "maildir_trash", DT_BOOL, false, 0, NULL,
    "Use the maildir 'trashed' flag, rather than deleting"
  },
  { NULL },
  // clang-format on
};

MaildirVarsHcache

struct ConfigDef MaildirVarsHcache[]

extern

Config definitions for the Maildir header cache.

Definition at line 90 of file config.c.

                                       {
  // clang-format off
  { "maildir_header_cache_verify", DT_BOOL, true, 0, NULL,
    "Check for maildir changes when opening mailbox"
  },
  { NULL },
  // clang-format on
};

ModuleMaildir

const struct Module ModuleMaildir

Initial value:

= {
  MODULE_ID_MAILDIR,
  "maildir",
  maildir_init,
  NULL, 
  maildir_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  maildir_cleanup,
}

Module for the Maildir library.

Definition at line 84 of file module.c.

                                    {
  MODULE_ID_MAILDIR,
  "maildir",
  maildir_init,
  NULL, // config_define_types
  maildir_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  maildir_cleanup,
};