module.c File Reference

Definition of the Imap Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	imap_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	imap_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()

Variables
struct ConfigDef	ImapVars []
	Config definitions for the IMAP library.
struct ConfigDef	ImapVarsZlib []
	Config definitions for IMAP compression.
const struct Command	ImapCommands []
	Imap Commands.
const struct Module	ModuleImap
	Module for the Imap library.

Detailed Description

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

imap_config_define_variables()

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

static

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

Definition at line 43 of file module.c.

{
  bool rc = cs_register_variables(cs, ImapVars);
 
#if defined(USE_ZLIB)
  rc |= cs_register_variables(cs, ImapVarsZlib);
#endif
 
  return rc;
}

Here is the call graph for this function:

imap_commands_register()

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

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 57 of file module.c.

{
  return commands_register(ca, ImapCommands);
}

Here is the call graph for this function:

Variable Documentation

ImapVars

struct ConfigDef ImapVars[]

extern

Config definitions for the IMAP library.

Definition at line 70 of file config.c.

                              {
  // clang-format off
  { "imap_check_subscribed", DT_BOOL, false, 0, NULL,
    "(imap) When opening a mailbox, ask the server for a list of subscribed folders"
  },
  { "imap_condstore", DT_BOOL, false, 0, NULL,
    "(imap) Enable the CONDSTORE extension"
  },
  { "imap_authenticators", DT_SLIST|D_SLIST_SEP_COLON, 0, 0, imap_auth_validator,
    "(imap) List of allowed IMAP authentication methods (colon-separated)"
  },
  { "imap_delim_chars", DT_STRING, IP "/.", 0, NULL,
    "(imap) Characters that denote separators in IMAP folders"
  },
  { "imap_fetch_chunk_size", DT_LONG|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "(imap) Download headers in blocks of this size"
  },
  { "imap_headers", DT_STRING, 0, 0, NULL,
    "(imap) Additional email headers to download when getting index"
  },
  { "imap_idle", DT_BOOL, false, 0, NULL,
    "(imap) Use the IMAP IDLE extension to check for new mail"
  },
  { "imap_login", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(imap) Login name for the IMAP server (defaults to `$imap_user`)"
  },
  { "imap_oauth_refresh_command", DT_STRING|D_STRING_COMMAND|D_SENSITIVE, 0, 0, NULL,
    "(imap) External command to generate OAUTH refresh token"
  },
  { "imap_pass", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(imap) Password for the IMAP server"
  },
  { "imap_pipeline_depth", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 15, 0, NULL,
    "(imap) Number of IMAP commands that may be queued up"
  },
  { "imap_rfc5161", DT_BOOL, true, 0, NULL,
    "(imap) Use the IMAP ENABLE extension to select capabilities"
  },
  { "imap_server_noise", DT_BOOL, true, 0, NULL,
    "(imap) Display server warnings as error messages"
  },
  { "imap_keep_alive", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 300, 0, NULL,
    "(imap) Time to wait before polling an open IMAP connection"
  },
  { "imap_list_subscribed", DT_BOOL, false, 0, NULL,
    "(imap) When browsing a mailbox, only display subscribed folders"
  },
  { "imap_passive", DT_BOOL, true, 0, NULL,
    "(imap) Reuse an existing IMAP connection to check for new mail"
  },
  { "imap_peek", DT_BOOL, true, 0, NULL,
    "(imap) Don't mark messages as read when fetching them from the server"
  },
  { "imap_poll_timeout", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 15, 0, NULL,
    "(imap) Maximum time to wait for a server response"
  },
  { "imap_qresync", DT_BOOL, false, 0, NULL,
    "(imap) Enable the QRESYNC extension"
  },
  { "imap_send_id", DT_BOOL, false, 0, NULL,
    "(imap) Send ID command when logging in"
  },
  { "imap_user", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(imap) Username for the IMAP server"
  },
 
  { "imap_keepalive",   DT_SYNONYM, IP "imap_keep_alive",   IP "2023-05-31" },
  { "imap_servernoise", DT_SYNONYM, IP "imap_server_noise", IP "2021-02-11" },
  { NULL },
  // clang-format on
};

ImapVarsZlib

struct ConfigDef ImapVarsZlib[]

extern

Config definitions for IMAP compression.

Definition at line 146 of file config.c.

                                  {
  // clang-format off
  { "imap_deflate", DT_BOOL, true, 0, NULL,
    "(imap) Compress network traffic"
  },
  { NULL },
  // clang-format on
};

ImapCommands

const struct Command ImapCommands[]

extern

Imap Commands.

Definition at line 186 of file imap.c.

                                      {
  // clang-format off
  { "subscribe-to", CMD_SUBSCRIBE_TO, parse_subscribe_to,
        N_("Subscribe to an IMAP mailbox"),
        N_("subscribe-to <imap-folder-uri>"),
        "optionalfeatures.html#imap" },
  { "unsubscribe-from", CMD_UNSUBSCRIBE_FROM, parse_unsubscribe_from,
        N_("Unsubscribe from an IMAP mailbox"),
        N_("unsubscribe-from <imap-folder-uri>"),
        "optionalfeatures.html#imap" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};

ModuleImap

const struct Module ModuleImap

Initial value:

= {
  MODULE_ID_IMAP,
  "imap",
  NULL, 
  NULL, 
  imap_config_define_variables,
  imap_commands_register,
  NULL, 
  NULL, 
  NULL, 
}

Module for the Imap library.

Definition at line 65 of file module.c.

                                 {
  MODULE_ID_IMAP,
  "imap",
  NULL, // init
  NULL, // config_define_types
  imap_config_define_variables,
  imap_commands_register,
  NULL, // gui_init
  NULL, // gui_cleanup
  NULL, // cleanup
};