* @page conn_globals Connection Global Variables
*
* These global variables are private to the connection library.
- *
- * | Global Variable | NeoMutt Config
- * | :--------------------- | :------------------------
- * | #CertificateFile | $certificate_file
- * | #ConnectTimeout | $connect_timeout
- * | #EntropyFile | $entropy_file
- * | #Preconnect | $preconnect
- * | #SslCaCertificatesFile | $ssl_ca_certificates_file
- * | #SslCiphers | $ssl_ciphers
- * | #SslClientCert | $ssl_client_cert
- * | #SslMinDhPrimeBits | $ssl_min_dh_prime_bits
- * | #Tunnel | $tunnel
*/
#include "config.h"
#include <stdio.h>
-short ConnectTimeout = 0; /**< Config: $connect_timeout */
+short ConnectTimeout = 0; /**< Config: Timeout for a network connection (for IMAP, POP or SMTP) */
#ifdef USE_SSL
-const char *CertificateFile = NULL; /**< Config: $certificate_file */
-const char *EntropyFile = NULL; /**< Config: $entropy_file */
-const char *SslCiphers = NULL; /**< Config: $ssl_ciphers */
-const char *SslClientCert = NULL; /**< Config: $ssl_client_cert */
+const char *CertificateFile = NULL; /**< Config: File containing trusted certificates */
+const char *EntropyFile = NULL; /**< Config: File containing random data to initialise SSL */
+const char *SslCiphers = NULL; /**< Config: Ciphers to use when using SSL */
+const char *SslClientCert = NULL; /**< Config: File containing client certificates */
#ifdef USE_SSL_GNUTLS
-const char *SslCaCertificatesFile = NULL; /**< Config: $ssl_ca_certificates_file */
-short SslMinDhPrimeBits = 0; /**< Config: $ssl_min_dh_prime_bits */
+const char *SslCaCertificatesFile = NULL; /**< Config: File containing trusted CA certificates */
+short SslMinDhPrimeBits = 0; /**< Config: Minimum keysize for Diffie-Hellman key exchange */
#endif
#endif
#ifdef USE_SOCKET
-const char *Preconnect = NULL; /**< Config: $preconnect */
-const char *Tunnel = NULL; /**< Config: $tunnel */
+const char *Preconnect = NULL; /**< Config: Shell command to run before making a connection */
+const char *Tunnel = NULL; /**< Config: Shell command to establish a tunnel */
#endif
* @page conn_getdomain DNS lookups
*
* DNS lookups
- *
- * | Function | Description
- * | :----------------- | :-----------------------------------
- * | getdnsdomainname() | Lookup the host's name using DNS
*/
#include "config.h"
* write. Thinking about it, the abstraction problem is that there is more in
* Connection than there needs to be. Ideally it would have only (void*)data
* and methods.
- *
- * | Function | Description
- * | :--------------------- | :-----------------------------------
- * | mutt_sasl_client_new() | wrapper for sasl_client_new
- * | mutt_sasl_done() | Invoke when processing is complete.
- * | mutt_sasl_interact() | Perform an SASL interaction with the user
- * | mutt_sasl_setup_conn() | Set up an SASL connection
*/
#include "config.h"
* @page conn_sasl_plain SASL plain authentication support
*
* SASL plain authentication support
- *
- * | Function | Description
- * | :-------------------- | :-----------------------------------
- * | mutt_sasl_plain_msg() | Create an SASL command
*/
#include "config.h"
* @page conn_socket Low-level socket handling
*
* Low-level socket handling
- *
- * | Function | Description
- * | :--------------------- | :-----------------------------------
- * | mutt_socket_close() | Close a socket
- * | mutt_socket_open() | Simple wrapper
- * | mutt_socket_poll() | Checks whether reads would block
- * | mutt_socket_readchar() | simple read buffering to speed things up
- * | mutt_socket_readln_d() | Read a line from a socket
- * | mutt_socket_write_d() | Write data to a socket
- * | raw_socket_close() | Close a socket
- * | raw_socket_open() | Open a socket
- * | raw_socket_poll() | Checks whether reads would block
- * | raw_socket_read() | Read data from a socket
- * | raw_socket_write() | Write data to a socket
- * | socket_new_conn() | allocate and initialise a new connection
*/
#include "config.h"
* @page conn_ssl Handling of OpenSSL encryption
*
* Handling of OpenSSL encryption
- *
- * | Function | Description
- * | :---------------------- | :-----------------------------------
- * | mutt_ssl_socket_setup() | Set up the socket multiplexor
- * | mutt_ssl_starttls() | Negotiate TLS over an already opened connection
*/
#include "config.h"
* @page conn_ssl_gnutls Handling of GnuTLS encryption
*
* Handling of GnuTLS encryption
- *
- * | Function | Description
- * | :---------------------- | :-----------------------------------
- * | mutt_ssl_socket_setup() | Set up SSL socket mulitplexor
- * | mutt_ssl_starttls() | Set up TLS multiplexor
*/
#include "config.h"
* @page conn_tunnel Support for network tunnelling
*
* Support for network tunnelling
- *
- * | Function | Description
- * | :------------------------- | :-----------------------------------
- * | mutt_tunnel_socket_setup() | setups tunnel connection functions.
*/
#include "config.h"
# set to NO
# The default value is: NO.
-HAVE_DOT = YES
+HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
* @page envelope Representation of an email header (envelope)
*
* Representation of an email header (envelope)
- *
- * | Function | Description
- * | :-------------------- | :---------------------------------
- * | mutt_env_cmp_strict() | Strictly compare two Envelopes
- * | mutt_env_free() | Free an Envelope
- * | mutt_env_merge() | Merge the headers of two Envelopes
- * | mutt_env_new() | Create a new Envelope
- * | mutt_env_to_intl() | Convert an Envelope's Address fields to Punycode format
- * | mutt_env_to_local() | Convert an Envelope's Address fields to local format
*/
#include "config.h"
*
* Read/write command history from/to a file.
*
- * | Data | Description
- * | :----------------- | :--------------------------------------------------
- * | #History | Number of history entries stored in memory
- * | #HistoryFile | File in which to store all the histories
- * | #HistoryRemoveDups | Remove duplicate history entries
- * | #SaveHistory | Number of history entries, per category, stored on disk
- *
- * | Function | Description
- * | :----------------------- | :---------------------------------------------------------
- * | mutt_hist_add() | Add a string to a history
- * | mutt_hist_at_scratch() | Is the current History position at the 'scratch' place?
- * | mutt_hist_init() | Create a set of empty History ring buffers
- * | mutt_hist_next() | Get the next string in a History
- * | mutt_hist_prev() | Get the previous string in a History
- * | mutt_hist_read_file() | Read the History from a file
- * | mutt_hist_reset_state() | Move the 'current' position to the end of the History
- * | mutt_hist_save_scratch() | Save a temporary string to the History
- *
* This history ring grows from 0..History, with last marking the
* where new entries go:
* ```
* @page imap_auth IMAP authenticator multiplexor
*
* IMAP authenticator multiplexor
- *
- * | Function | Description
- * | :------------------ | :-------------------------------------------------
- * | imap_authenticate() | Authenticate to an IMAP server
*/
#include "config.h"
* @page imap_auth_anon IMAP anonymous authentication method
*
* IMAP anonymous authentication method
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_auth_anon() | Authenticate anonymously
*/
#include "config.h"
* @page imap_auth_cram IMAP CRAM-MD5 authentication method
*
* IMAP CRAM-MD5 authentication method
- *
- * | Function | Description
- * | :------------------- | :-------------------------------------------------
- * | imap_auth_cram_md5() | Authenticate using CRAM-MD5
*/
#include "config.h"
* @page imap_auth_gss IMAP GSS authentication method
*
* IMAP GSS authentication method
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_auth_gss() | GSS Authentication support
*/
#include "config.h"
* @page imap_auth_login IMAP login authentication method
*
* IMAP login authentication method
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_auth_login() | Plain LOGIN support
*/
#include "config.h"
* @page imap_auth_plain IMAP plain authentication method
*
* IMAP plain authentication method
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_auth_plain() | SASL PLAIN support
*/
#include "config.h"
* @page imap_auth_sasl IMAP SASL authentication method
*
* IMAP SASL authentication method
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_auth_sasl() | Default authenticator if available
*/
#include "config.h"
* @page imap_browse Mailbox browser
*
* GUI select an IMAP mailbox from a list
- *
- * | Function | Description
- * | :-------------------- | :-------------------------------------------------
- * | imap_browse() | IMAP hook into the folder browser
- * | imap_mailbox_create() | Create a new IMAP mailbox
- * | imap_mailbox_rename() | Rename a mailbox
*/
#include "config.h"
* @page imap_command Send/receive commands to/from an IMAP server
*
* Send/receive commands to/from an IMAP server
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_cmd_finish() | Attempt to perform cleanup
- * | imap_cmd_idle() | Enter the IDLE state
- * | imap_cmd_start() | Given an IMAP command, send it to the server
- * | imap_cmd_step() | Reads server responses from an IMAP command
- * | imap_cmd_trailer() | Extra information after tagged command response if any
- * | imap_code() | Was the command successful
- * | imap_exec() | Execute a command and wait for the response from the server
*/
#include "config.h"
*
* Support for IMAP4rev1, with the occasional nod to IMAP 4.
*
- * | Function | Description
- * | :--------------------------- | :-------------------------------------------------
- * | imap_access() | Check permissions on an IMAP mailbox
- * | imap_buffy_check() | Check for new mail in subscribed folders
- * | imap_check() | Check for new mail
- * | imap_check_mailbox() | use the NOOP or IDLE command to poll for new mail
- * | imap_close_connection() | Close an IMAP connection
- * | imap_complete() | Try to complete an IMAP folder path
- * | imap_conn_find() | Find an open IMAP connection
- * | imap_create_mailbox() | Create a new mailbox
- * | imap_delete_mailbox() | Delete a mailbox
- * | imap_exec_msgset() | Prepare commands for all messages matching conditions
- * | imap_expunge_mailbox() | Purge messages from the server
- * | imap_fast_trash() | Use server COPY command to copy deleted messages to trash
- * | imap_has_flag() | Does the flag exist in the list
- * | imap_logout() | Gracefully log out of server
- * | imap_logout_all() | close all open connections
- * | imap_mboxcache_free() | Free the cached ImapStatus
- * | imap_mboxcache_get() | Open an hcache for a mailbox
- * | imap_open_connection() | Open an IMAP connection
- * | imap_read_literal() | Read bytes bytes from server into file
- * | imap_rename_mailbox() | Rename a mailbox
- * | imap_search() | Find a matching mailbox
- * | imap_status() | Get the status of a mailbox
- * | imap_subscribe() | Subscribe to a mailbox
- * | imap_sync_message_for_copy() | Update server to reflect the flags of a single message
- *
- * | Data | Description
- * | :----------------- | :--------------------------------------------------
- * | #mx_comp_ops | Mailbox callback functions
- *
- * | Function | Description
- * | :-------------------------- | :-------------------------------------------------
- * | imap_check_mailbox_reopen() | Check for new mail (reopen mailbox if necessary)
- * | imap_close_mailbox() | Clean up IMAP data in Context
- * | imap_commit_message_tags() | Add/Change/Remove flags from headers
- * | imap_edit_message_tags() | Prompt and validate new messages tags
- * | imap_open_mailbox() | Open an IMAP mailbox
- * | imap_open_mailbox_append() | Open an IMAP mailbox to append
- * | imap_open_new_message() | Open an IMAP message
- * | imap_sync_mailbox() | Sync all the changes to the server
+ * | Data | Description
+ * | :----------- | :-------------------------
+ * | #mx_imap_ops | Mailbox callback functions
*/
#include "config.h"
}
/**
- * mx_comp_ops - Mailbox callback functions
+ * mx_imap_ops - Mailbox callback functions
*/
struct MxOps mx_imap_ops = {
.open = imap_open_mailbox,
* @page imap_message Manage IMAP messages
*
* Manage IMAP messages
- *
- * | Function | Description
- * | :---------------------- | :-------------------------------------------------
- * | imap_append_message() | Write an email back to the server
- * | imap_cache_clean() | Delete all the entries in the message cache
- * | imap_cache_del() | Delete an email from the body cache
- * | imap_close_message() | Close an email
- * | imap_commit_message() | Save changes to an email
- * | imap_copy_messages() | Server COPY messages to another folder
- * | imap_fetch_message() | Fetch an email from an IMAP server
- * | imap_free_header_data() | free ImapHeader structure
- * | imap_read_headers() | Read headers from the server
- * | imap_set_flags() | fill the message header according to the server flags
*/
#include "config.h"
* @page imap_utf7 UTF-7 Manipulation
*
* Convert strings to/from utf7/utf8
- *
- * | Function | Description
- * | :----------------- | :-------------------------------------------------
- * | imap_utf_decode() | Decode email from UTF-8 to local charset
- * | imap_utf_encode() | Encode email from local charset to UTF-8
*/
#include "config.h"
* @page imap_util IMAP helper functions
*
* IMAP helper functions
- *
- * | Function | Description
- * | :----------------------- | :-------------------------------------------------
- * | imap_account_match() | Compare two Accounts
- * | imap_allow_reopen() | Allow re-opening a folder upon expunge
- * | imap_cachepath() | Generate a cache path for a mailbox
- * | imap_clean_path() | Cleans an IMAP path using imap_fix_path
- * | imap_continue() | display a message and ask the user if they want to go on
- * | imap_disallow_reopen() | Disallow re-opening a folder upon expunge
- * | imap_error() | show an error and abort
- * | imap_expand_path() | Canonicalise an IMAP path
- * | imap_fix_path() | Fix up the imap path
- * | imap_free_idata() | Release and clear storage in an ImapData structure
- * | imap_get_literal_count() | write number of bytes in an IMAP literal into bytes
- * | imap_get_parent() | Get an IMAP folder's parent
- * | imap_get_parent_path() | Get the path of the parent folder
- * | imap_get_qualifier() | Get the qualifier from a tagged response
- * | imap_hcache_close() | Close the header cache
- * | imap_hcache_del() | Delete an item from the header cache
- * | imap_hcache_get() | Get a header cache entry by its UID
- * | imap_hcache_namer() | Generate a filename for the header cache
- * | imap_hcache_open() | Open a header cache
- * | imap_hcache_put() | Add an entry to the header cache
- * | imap_keepalive() | poll the current folder to keep the connection alive
- * | imap_munge_mbox_name() | Quote awkward characters in a mailbox name
- * | imap_mxcmp() | Compare mailbox names, giving priority to INBOX
- * | imap_new_idata() | Allocate and initialise a new ImapData structure
- * | imap_next_word() | Find where the next IMAP word begins
- * | imap_parse_path() | Parse an IMAP mailbox name into name,host,port
- * | imap_pretty_mailbox() | Prettify an IMAP mailbox name
- * | imap_qualify_path() | Make an absolute IMAP folder target
- * | imap_quote_string() | quote string according to IMAP rules
- * | imap_unmunge_mbox_name() | Remove quoting from a mailbox name
- * | imap_unquote_string() | equally stupid unquoting routine
- * | imap_wait_keepalive() | Wait for a process to change state
*/
#include "config.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * This file contains routines specific to MH and ``maildir'' style
- * mailboxes.
- */
-
#include "config.h"
#include <ctype.h>
#include <dirent.h>
* @retval ptr Memory on the heap
*
* @note This function will never return NULL.
- * It will print and error and exit the program.
+ * It will print an error and exit the program.
*
* The caller should call mutt_mem_free() to release the memory
*/
* @retval ptr Memory on the heap
*
* @note This function will never return NULL.
- * It will print and error and exit the program.
+ * It will print an error and exit the program.
*
* The caller should call mutt_mem_free() to release the memory
*/
* @param size New size
*
* @note This function will never return NULL.
- * It will print and error and exit the program.
+ * It will print an error and exit the program.
*
* If the new size is zero, the block will be freed.
*/
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * This file is named mutt_menu.h so it doesn't collide with ncurses menu.h
- */
-
#ifndef _MUTT_MENU_H
#define _MUTT_MENU_H
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * This header file contains prototypes for internal functions used by the
- * generic mailbox api. None of these functions should be called directly.
- */
-
#ifndef _MUTT_MX_H
#define _MUTT_MX_H
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- This is a crytpo module wrapping the classic pgp code.
- */
-
#include "config.h"
#include <stdio.h>
#include "crypt_mod.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- This is a crypto module wrapping the gpgme based pgp code.
- */
-
#include "config.h"
#include <stdio.h>
#include "crypt_gpgme.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- This is a crytpo module wrapping the classic smime code.
- */
-
#include "config.h"
#include <stdio.h>
#include "crypt_mod.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- This is a crypto module wrapping the gpgme based smime code.
- */
-
#include "config.h"
#include <stdio.h>
#include "crypt_gpgme.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- This file dispatches the generic crypto functions to the
- implemented backend or provides dummy stubs. Note, that some
- generic functions are handled in crypt.c.
-*/
+/* This file dispatches the generic crypto functions to the implemented backend
+ * or provides dummy stubs. Note, that some generic functions are handled in
+ * crypt.c.
+ */
-/* Note: This file has been changed to make use of the new module
- system. Consequently there's a 1:1 mapping between the functions
- contained in this file and the functions implemented by the crypto
- modules. */
+/* Note: This file has been changed to make use of the new module system.
+ * Consequently there's a 1:1 mapping between the functions contained in this
+ * file and the functions implemented by the crypto modules.
+ */
#include "config.h"
#include <stdio.h>
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * NOTE
- *
- * This code used to be the parser for GnuPG's output.
+/* NOTE: This code used to be the parser for GnuPG's output.
*
* Nowadays, we are using an external pubring lister with PGP which mimics
* gpg's output format.
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- Common definitions and prototypes for the crypt functions. They are
- all defined in crypt.c and cryptglue.c
-*/
-
#ifndef _NCRYPT_NCRYPT_H
#define _NCRYPT_NCRYPT_H
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * This file contains all of the PGP routines necessary to sign, encrypt,
- * verify and decrypt PGP messages in either the new PGP/MIME format, or
- * in the older Application/Pgp format. It also contains some code to
- * cache the user's passphrase for repeat use when decrypting or signing
- * a message.
+/* This file contains all of the PGP routines necessary to sign, encrypt,
+ * verify and decrypt PGP messages in either the new PGP/MIME format, or in the
+ * older Application/Pgp format. It also contains some code to cache the
+ * user's passphrase for repeat use when decrypting or signing a message.
*/
#include "config.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * Definitions for a rudimentary PGP packet parser which is shared
- * by neomutt proper and the PGP public key ring lister.
+/* Definitions for a rudimentary PGP packet parser which is shared by neomutt
+ * proper and the PGP public key ring lister.
*/
#ifndef _NCRYPT_PGPPACKET_H
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * Mixmaster support for NeoMutt
- */
-
#include "config.h"
#include <fcntl.h>
#include <limits.h>
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * Mixmaster support for NeoMutt
- */
-
#ifndef _MUTT_REMAILER_H
#define _MUTT_REMAILER_H
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * rfc1524 defines a format for the Multimedia Mail Configuration, which
- * is the standard mailcap file format under Unix which specifies what
- * external programs should be used to view/compose/edit multimedia files
- * based on content type.
+/* RFC1524 defines a format for the Multimedia Mail Configuration, which is the
+ * standard mailcap file format under Unix which specifies what external
+ * programs should be used to view/compose/edit multimedia files based on
+ * content type.
*
* This file contains various functions for implementing a fair subset of
- * rfc1524.
+ * RFC1524.
*/
#include "config.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * Yet another MIME encoding for header data. This time, it's
- * parameters, specified in RFC2231, and modeled after the
- * encoding used in URLs.
+/* Yet another MIME encoding for header data. This time, it's parameters,
+ * specified in RFC2231, and modeled after the encoding used in URLs.
*
- * Additionally, continuations and encoding are mixed in an, errrm,
- * interesting manner.
+ * Additionally, continuations and encoding are mixed in an, errrm, interesting
+ * manner.
*/
#include "config.h"
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * A simple URL parser.
- */
-
#include "config.h"
#include <ctype.h>
#include <stdio.h>
projects / neomutt / commitdiff