module.c File Reference

Definition of the Pop 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	pop_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	pop_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	pop_cleanup (struct NeoMutt *n)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	PopVars []
	Config definitions for the POP library.
const struct Module	ModulePop
	Module for the Pop library.

Detailed Description

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

pop_init()

static bool pop_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 42 of file module.c.

{
  // struct PopModuleData *md = MUTT_MEM_CALLOC(1, struct PopModuleData);
  // neomutt_set_module_data(n, MODULE_ID_POP, md);
 
  return true;
}

pop_config_define_variables()

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

static

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

Definition at line 53 of file module.c.

{
  return cs_register_variables(cs, PopVars);
}

Here is the call graph for this function:

pop_cleanup()

static bool pop_cleanup ( struct NeoMutt * n )

static

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

Definition at line 61 of file module.c.

{
  // struct PopModuleData *md = neomutt_get_module_data(n, MODULE_ID_POP);
  // ASSERT(md);
 
  // FREE(&md);
  return true;
}

Variable Documentation

PopVars

struct ConfigDef PopVars[]

extern

Config definitions for the POP library.

Definition at line 70 of file config.c.

                             {
  // clang-format off
  { "pop_auth_try_all", DT_BOOL, true, 0, NULL,
    "(pop) Try all available authentication methods"
  },
  { "pop_authenticators", DT_SLIST|D_SLIST_SEP_COLON, 0, 0, pop_auth_validator,
    "(pop) List of allowed authentication methods (colon-separated)"
  },
  { "pop_check_interval", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 60, 0, NULL,
    "(pop) Interval between checks for new mail"
  },
  { "pop_delete", DT_QUAD, MUTT_ASKNO, 0, NULL,
    "(pop) After downloading POP messages, delete them on the server"
  },
  { "pop_host", DT_STRING, 0, 0, NULL,
    "(pop) Url of the POP server"
  },
  { "pop_last", DT_BOOL, false, 0, NULL,
    "(pop) Use the 'LAST' command to fetch new mail"
  },
  { "pop_oauth_refresh_command", DT_STRING|D_STRING_COMMAND|D_SENSITIVE, 0, 0, NULL,
    "(pop) External command to generate OAUTH refresh token"
  },
  { "pop_pass", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(pop) Password of the POP server"
  },
  { "pop_reconnect", DT_QUAD, MUTT_ASKYES, 0, NULL,
    "(pop) Reconnect to the server is the connection is lost"
  },
  { "pop_user", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(pop) Username of the POP server"
  },
 
  { "pop_checkinterval", DT_SYNONYM, IP "pop_check_interval", IP "2021-02-11" },
  { NULL },
  // clang-format on
};

ModulePop

const struct Module ModulePop

Initial value:

= {
  MODULE_ID_POP,
  "pop",
  pop_init,
  NULL, 
  pop_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  pop_cleanup,
}

Module for the Pop library.

Definition at line 73 of file module.c.

                                {
  MODULE_ID_POP,
  "pop",
  pop_init,
  NULL, // config_define_types
  pop_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  pop_cleanup,
};