module.c File Reference

Definition of the Notmuch 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	notmuch_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	notmuch_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	notmuch_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	notmuch_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	notmuch_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()
static bool	notmuch_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	NotmuchVars []
	Config definitions for the Notmuch library.
const struct Command	NmCommands []
	Notmuch Commands.
const struct Module	ModuleNotmuch
	Module for the Notmuch library.

Detailed Description

Definition of the Notmuch 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

notmuch_init()

static bool notmuch_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 44 of file module.c.

{
  struct NotmuchModuleData *mod_data = MUTT_MEM_CALLOC(1, struct NotmuchModuleData);
  neomutt_set_module_data(n, MODULE_ID_NOTMUCH, 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:

notmuch_config_define_variables()

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

static

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

Definition at line 58 of file module.c.

{
  bool rc = false;
 
#if defined(USE_NOTMUCH)
  rc |= cs_register_variables(cs, NotmuchVars);
#endif
 
  return rc;
}

Here is the call graph for this function:

notmuch_commands_register()

static bool notmuch_commands_register ( struct NeoMutt * n, struct CommandArray * ca )

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 72 of file module.c.

{
  return commands_register(ca, NmCommands);
}

Here is the call graph for this function:

notmuch_gui_init()

static bool notmuch_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 80 of file module.c.

{
  const bool c_virtual_spool_file = cs_subset_bool(n->sub, "virtual_spool_file");
  if (c_virtual_spool_file)
  {
    /* Find the first virtual folder and open it */
    struct MailboxArray ma = neomutt_mailboxes_get(n, MUTT_NOTMUCH);
    struct Mailbox **mp = ARRAY_FIRST(&ma);
    if (mp)
      cs_str_string_set(n->cs, "spool_file", mailbox_path(*mp), NULL);
    ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
  }
  return true;
}

Here is the call graph for this function:

notmuch_gui_cleanup()

static void notmuch_gui_cleanup ( struct NeoMutt * n )

static

Clean up the GUI - Implements Module::gui_cleanup()

Definition at line 98 of file module.c.

{
}

notmuch_cleanup()

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

static

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

Definition at line 105 of file module.c.

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

Here is the call graph for this function:

Variable Documentation

NotmuchVars

struct ConfigDef NotmuchVars[]

extern

Config definitions for the Notmuch library.

Definition at line 75 of file config.c.

                                 {
  // clang-format off
  { "nm_config_file", DT_PATH|D_PATH_FILE, IP "auto", 0, NULL,
    "(notmuch) Configuration file for notmuch. Use 'auto' to detect configuration."
  },
  { "nm_config_profile", DT_STRING, 0, 0, NULL,
    "(notmuch) Configuration profile for notmuch."
  },
  { "nm_db_limit", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "(notmuch) Default limit for Notmuch queries"
  },
  { "nm_default_url", DT_STRING, 0, 0, nm_default_url_validator,
    "(notmuch) Path to the Notmuch database"
  },
  { "nm_exclude_tags", DT_STRING, 0, 0, NULL,
    "(notmuch) Exclude messages with these tags"
  },
  { "nm_flagged_tag", DT_STRING, IP "flagged", 0, NULL,
    "(notmuch) Tag to use for flagged messages"
  },
  { "nm_open_timeout", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 5, 0, NULL,
    "(notmuch) Database timeout"
  },
  { "nm_query_type", DT_ENUM, NM_QUERY_TYPE_MESSAGES, IP &NmQueryTypeDef, NULL,
    "(notmuch) Default query type: 'threads' or 'messages'"
  },
  { "nm_query_window_current_position", DT_NUMBER, 0, 0, NULL,
    "(notmuch) Position of current search window"
  },
  { "nm_query_window_current_search", DT_STRING, 0, 0, NULL,
    "(notmuch) Current search parameters"
  },
  { "nm_query_window_duration", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "(notmuch) Time duration of the current search window"
  },
  { "nm_query_window_enable", DT_BOOL, false, 0, NULL,
    "(notmuch) Enable query windows"
  },
  { "nm_query_window_or_terms", DT_STRING, 0, 0, NULL,
    "(notmuch) Additional notmuch search terms for messages to be shown regardless of date"
  },
  { "nm_query_window_timebase", DT_ENUM, NMTB_WEEK, IP &NmQueryWindowTimebaseDef, NULL,
    "(notmuch) Units for the time duration"
  },
  { "nm_record_tags", DT_STRING, 0, 0, NULL,
    "(notmuch) Tags to apply to the 'record' mailbox (sent mail)"
  },
  { "nm_replied_tag", DT_STRING, IP "replied", 0, NULL,
    "(notmuch) Tag to use for replied messages"
  },
  { "nm_unread_tag", DT_STRING, IP "unread", 0, NULL,
    "(notmuch) Tag to use for unread messages"
  },
  { "virtual_spool_file", DT_BOOL, false, 0, NULL,
    "(notmuch) Use the first virtual mailbox as a spool file"
  },
 
  { "vfolder_format",     D_INTERNAL_DEPRECATED|DT_STRING, 0,  IP "2018-11-01" },
 
  { "nm_default_uri",     DT_SYNONYM, IP "nm_default_url",     IP "2021-02-11" },
  { "virtual_spoolfile",  DT_SYNONYM, IP "virtual_spool_file", IP "2025-12-08" },
  { NULL },
  // clang-format on
};

NmCommands

const struct Command NmCommands[]

extern

Notmuch Commands.

Definition at line 91 of file notmuch.c.

                                    {
  // clang-format off
  // Deprecated
  { "unvirtual-mailboxes", CMD_NONE, NULL, "unmailboxes",     NULL, NULL, CF_SYNONYM },
  { "virtual-mailboxes",   CMD_NONE, NULL, "named-mailboxes", NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};

ModuleNotmuch

const struct Module ModuleNotmuch

Initial value:

= {
  MODULE_ID_NOTMUCH,
  "notmuch",
  notmuch_init,
  NULL, 
  notmuch_config_define_variables,
  notmuch_commands_register,
  notmuch_gui_init,
  notmuch_gui_cleanup,
  notmuch_cleanup,
}

Module for the Notmuch library.

Definition at line 118 of file module.c.

                                    {
  MODULE_ID_NOTMUCH,
  "notmuch",
  notmuch_init,
  NULL, // config_define_types
  notmuch_config_define_variables,
  notmuch_commands_register,
  notmuch_gui_init,
  notmuch_gui_cleanup,
  notmuch_cleanup,
};