module.c File Reference

Definition of the Attach Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	attach_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	attach_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	attach_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	attach_cleanup (struct NeoMutt *n)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	AttachVars []
	Config definitions for the Attach library.
const struct Command	AttachCommands []
	Attach Commands.
const struct Module	ModuleAttach
	Module for the Attach library.

Detailed Description

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

attach_init()

static bool attach_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 46 of file module.c.

{
  struct AttachModuleData *md = MUTT_MEM_CALLOC(1, struct AttachModuleData);
  neomutt_set_module_data(n, MODULE_ID_ATTACH, md);
 
  STAILQ_INIT(&md->attach_allow);
  STAILQ_INIT(&md->attach_exclude);
  STAILQ_INIT(&md->inline_allow);
  STAILQ_INIT(&md->inline_exclude);
 
  STAILQ_INIT(&md->mime_lookup);
  STAILQ_INIT(&md->temp_attachments);
 
  md->attachments_notify = notify_new();
  notify_set_parent(md->attachments_notify, NeoMutt->notify);
 
  return true;
}

Here is the call graph for this function:

attach_config_define_variables()

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

static

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

Definition at line 68 of file module.c.

{
  return cs_register_variables(cs, AttachVars);
}

Here is the call graph for this function:

attach_commands_register()

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

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 76 of file module.c.

{
  return commands_register(ca, AttachCommands);
}

Here is the call graph for this function:

attach_cleanup()

static bool attach_cleanup ( struct NeoMutt * n )

static

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

Definition at line 84 of file module.c.

{
  struct AttachModuleData *md = neomutt_get_module_data(n, MODULE_ID_ATTACH);
  ASSERT(md);
 
  notify_free(&md->attachments_notify);
 
  /* Lists of AttachMatch */
  mutt_list_free_type(&md->attach_allow, (list_free_t) attachmatch_free);
  mutt_list_free_type(&md->attach_exclude, (list_free_t) attachmatch_free);
  mutt_list_free_type(&md->inline_allow, (list_free_t) attachmatch_free);
  mutt_list_free_type(&md->inline_exclude, (list_free_t) attachmatch_free);
 
  mutt_list_free(&md->mime_lookup);
 
  mutt_temp_attachments_cleanup();
 
  FREE(&md);
  return true;
}

Here is the call graph for this function:

Variable Documentation

AttachVars

struct ConfigDef AttachVars[]

extern

Config definitions for the Attach library.

Definition at line 40 of file config.c.

                                {
  // clang-format off
  { "attach_save_dir", DT_PATH|D_PATH_DIR, IP "./", 0, NULL,
    "Default directory where attachments are saved"
  },
  { "attach_save_without_prompting", DT_BOOL, false, 0, NULL,
    "If true, then don't prompt to save"
  },
  { "attach_sep", DT_STRING, IP "\n", 0, NULL,
    "Separator to add between saved/printed/piped attachments"
  },
  { "attach_split", DT_BOOL, true, 0, NULL,
    "Save/print/pipe tagged messages individually"
  },
  { "bounce", DT_QUAD, MUTT_ASKYES, 0, NULL,
    "Confirm before bouncing a message"
  },
  { "count_alternatives", DT_BOOL, false, 0, NULL,
    "Recurse inside multipart/alternatives while counting attachments"
  },
  { "digest_collapse", DT_BOOL, true, 0, NULL,
    "Hide the subparts of a multipart/digest"
  },
  { "message_format", DT_EXPANDO|D_NOT_EMPTY, IP "%s", IP &IndexFormatDef, NULL,
    "printf-like format string for listing attached messages"
  },
  { "mime_forward", DT_QUAD, MUTT_NO, 0, NULL,
    "Forward a message as a 'message/RFC822' MIME part"
  },
  { "mime_forward_rest", DT_QUAD, MUTT_YES, 0, NULL,
    "Forward all attachments, even if they can't be decoded"
  },
 
  { "mime_fwd",   DT_SYNONYM, IP "mime_forward",   IP "2021-03-21" },
  { "msg_format", DT_SYNONYM, IP "message_format", IP "2021-03-21" },
 
  { NULL },
  // clang-format on
};

AttachCommands

const struct Command AttachCommands[]

extern

Attach Commands.

Definition at line 680 of file commands.c.

                                        {
  // clang-format off
  { "attachments", CMD_ATTACHMENTS, parse_attachments,
        N_("Set attachment counting rules"),
        N_("attachments { + | - }<disposition> <mime-type> [ <mime-type> ... ] | ?"),
        "mimesupport.html#attachments" },
  { "mime-lookup", CMD_MIME_LOOKUP, parse_mime_lookup,
        N_("Map specified MIME types/subtypes to display handlers"),
        N_("mime-lookup <mime-type>[/<mime-subtype> ] [ ... ]"),
        "mimesupport.html#mime-lookup" },
  { "unattachments", CMD_UNATTACHMENTS, parse_unattachments,
        N_("Remove attachment counting rules"),
        N_("unattachments { * | { + | - }<disposition> <mime-type> [ ... ] }"),
        "mimesupport.html#attachments" },
  { "unmime-lookup", CMD_UNMIME_LOOKUP, parse_unmime_lookup,
        N_("Remove custom MIME-type handlers"),
        N_("unmime-lookup { * | [ <mime-type>[/<mime-subtype> ] ... ] }"),
        "mimesupport.html#mime-lookup" },
 
  // Deprecated
  { "mime_lookup",         CMD_NONE, NULL, "mime-lookup",         NULL, NULL, CF_SYNONYM },
  { "unmime_lookup",       CMD_NONE, NULL, "unmime-lookup",       NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};

ModuleAttach

const struct Module ModuleAttach

Initial value:

= {
  MODULE_ID_ATTACH,
  "attach",
  attach_init,
  NULL, 
  attach_config_define_variables,
  attach_commands_register,
  NULL, 
  NULL, 
  attach_cleanup,
}

Module for the Attach library.

Definition at line 108 of file module.c.

                                   {
  MODULE_ID_ATTACH,
  "attach",
  attach_init,
  NULL, // config_define_types
  attach_config_define_variables,
  attach_commands_register,
  NULL, // gui_init
  NULL, // gui_cleanup
  attach_cleanup,
};