Libraries

These libraries contain are an attempt to make NeoMutt more modular.

[detail level 12]

►Address
Email address
Config used by libaddress
Config type: Email address
Address groups
International domain names
Handle mailing lists
Definition of the Address Module
►Alias
Alias for an email address
Parse Alternate Commands
Array of Alias Views
Alias commands
Alias Auto-Completion
Alias Config
Address Book Dialog
Address Query Dialog
Alias Expando definitions
Alias functions
Shared code for alias dialogs
Definition of the Alias Module
Reverse Alias lookups
Alias sorting
►Attachments
Email attachments
Attachment Content-ID header functions
Attachment commands
Config used by libattach
Attachment Selection Dialog
Attach Expando definitions
Attachment functions
Attachment library
Definition of the Attach Module
Shared attachments functions
Private state data for Attachments
Attachment functions
Send/reply with an attachment
►Autocrypt
Autocrypt shared code
Private Autocrypt Data
Autocrypt Config
Autocrypt database handling
Autocrypt account dialog
Autocrypt Expando definitions
Autocrypt functions
Autocrypt GPGME handler
Definition of the Autocrypt Module
Autocrypt database schema
►Body (Message) Cache
Body Cache functions
Definition of the Bcache Module
►Mailbox Browser
Browser Auto-Completion
Config used by libbrowser
File/Mailbox Browser Dialog
Browser Expando definitions
Browser functions
Definition of the Browser Module
Private data for the Browser
Browser sorting
►Parse the Command Line
Parse the Command Line
Parse objects
►Color
ANSI Colours
Colour and attributes
Color and attribute parsing
Parse colour commands
Curses Colour
Colour Debugging
Colour Dump Command
Merged colours
Definition of the Color Module
Colour notifications
Parse ANSI Sequences
Parse colour commands
Quoted style
Quoted-Email colours
Regex Colour
Simple colour
►NeoMutt Commands
Setup NeoMutt Commands
Parse Ifdef Commands
Parse Mailboxes Commands
Definition of the Commands Module
Parse Simple Commands
Parse Setenv Commands
Parse Source Commands
Parse Stailq Commands
►Auto-completion
String auto-completion routines
String auto-completion data
Auto-completion helpers
Definition of the Complete Module
►Compressed Mailbox
Compressed mailbox functions
Compress Expando definitions
Definition of the Compmbox Module
►Compose an Email
Attachments window
Attachment Data
Compose Bar (status)
Compose Bar Data
Config used by Compose
Compose Email Dialog
Alias Expando definitions
Compose functions
Definition of the Compose Module
Message Preview Window
Compose Shared Data
►Compression functions
Shared compression code
Definition of the Compress Module
LZ4 compression
ZLIB compression
Zstandard (zstd) compression
►Config
Type: Boolean
Validate charset
Dump all the config
Type: Enumeration
Helper functions to get config values
Type: Long
Type: Multi-byte character table
Definition of the Config Module
Type: MyVar
Type: Number
Type: Path
Type: Quad-option
Type: Regular expression
Config Set
Type: List of strings
Type: Sorting
Type: String
Subset of config items
►Network connections
Connection Credentials External Command
Config used by libconn
Connection Credentials
Certificate Verification Dialog
DNS lookups
GnuTLS encryption
GNU SASL authentication support
Definition of the Conn Module
ConnAccount object used by POP and IMAP
OpenSSL encryption
Low-level socket code
SASL authentication
SASL plain authentication
Low-level socket handling
Network tunnelling
Zlib compression of network traffic
►File Charset Conversion
Content Info Extraction
File Charset Conversion
Definition of the Convert Module
►Core NeoMutt objects
Account object
NeoMutt Commands
Cache of config variables
Dispatcher of functions
Mailbox object
Local email
Definition of the Core Module
Module API
NeoMutt object
Create Temporary Files
►Debug Code
Code backtrace
Shared debug code
Dump an Email
GraphViz dot file
Dump keybindings
Log everything to the terminal
Debug names
Dump all notifications
Pager Debugging
Dump the Windows
►Edit a string
Enter buffer
Editor functions
Definition of the Editor Module
State of text entry
GUI ask the user to enter a string
►Email code
Body of an Email
Email commands
Config used by the Email library
Copy the body of an email
Duplicate the structure of an entire email
Email object
Rich text handler
Envelope (Email header)
Who is the email from?
Parse Group/Lists Commands
Decide how to display email content
Manipulate an email's header
Parse Ignore Commands
RFC1524 Mailcap routines
Data for MIME encoding
Definition of the Email Module
Attributes for a MIME part
Email parsing code
RFC2047 encoding / decoding
RFC2231 MIME Charset functions
RFC3676 Format Flowed routines
Routines for adding user scores to emails
Email sorting methods
Parse Spam Commands
Email tags
Email threading
Parse URL schemes
►Envelope-editing Window
Envelope functions
Definition of the Envelope Module
Envelope Window Data
Envelope Window
►Parse Expando string
Type: Expando
Parsed Expando
Expando filtering
Simple string formatting
Shared code
Definition of the Expando Module
Basic Expando Node
Condition Boolean Node
Conditional Date Node
Condition Node
Container Node
Expando Node
Padding Node
Text Node
Expando Parsing
Render Expandos using Data
Dump the details of an Expando Tree
Fuzzy matching benchmark
►Fuzzy matching library
Fuzzy matching dispatcher
Subsequence fuzzy matching
►Graphical code
Config used by libgui
Window drawing code
Dialog Windows
Definitions of user functions
Global functions
Definition of the Gui Module
Message Container
Message Window
Message Window private data
Wrapper around Curses
Window management
View of a Mailbox
All user-callable functions
Window reflowing
GUI handle the resizing of the screen
Root Window
Simple Bar (status)
Simple Dialog
Set the terminal title/icon
Create/manipulate threading in emails
►Email Header Cache
Config used by Header Cache
Header cache multiplexor
Definition of the Hcache Module
Email-object serialiser
►Help bar
Help Bar Window
Config used by Help Bar
Definition of the Helpbar Module
Data for the Help Bar
►History
Config used by the history
History Selection Dialog
History Expando definitions
History functions
History file handling
Definition of the History Module
►Hook Commands
Hook Commands
Config used by libhooks
Dump the Hooks to the Pager
Execute user-defined Hooks
User-defined Hooks
Definition of the Hooks Module
Parse user-defined Hooks
►Imap Mailbox
Account data
Authenticator multiplexor
Anonymous authentication
CRAM-MD5 authentication
GNU SASL authentication
GSS authentication
Login authentication
OAUTH authentication
Plain authentication
SASL authentication
Mailbox browser
Send/receive commands
Config used by IMAP
Imap-specific Email data
IMAP network mailbox
Imap-specific Mailbox data
IMAP messages
Definition of the Imap Module
IMAP Message Sets
MSN helper functions
Search routines
UTF-7 Manipulation
IMAP helper functions
►Index
Index commands
Config used by the Index
Index Dialog
String processing routines to generate the mail index
GUI display a user-configurable status line
Index functions
Index Bar (status)
Index Window
Index Panel
Definition of the Index Module
Private data for the Index
Shared data
GUI display a user-configurable status line
Parse subject-regex Commands
►Key mappings
Parse key binding commands
Dump key bindings
Set up the extended keys
Get a key from the user
Set up the key bindings
Keymap handling
Maniplate Menus and SubMenus
Definition of the Key Module
►Integrated Lua scripting
Lua Commands
Definition of the Lua Module
Integrated Lua scripting
►Maildir Mailbox
Maildir Account
Config used by Maildir
Maildir-specific Email data
Maildir Header Cache
Maildir Mailbox
Maildir local mailbox type
Maildir-specific Mailbox data
Maildir Email helper
Maildir Message
Definition of the Maildir Module
Maildir Path handling
Maildir shared functions
►Mbox
Config used by libmbox
Mbox local mailbox type
Definition of the Mbox Module
►Menu
Config used by libmenu
Paint the Menu
Menu functions
GUI present the user with a selectable list
Definition of the Menu Module
Change the Menu's position/selection
Menu notification observers
Tagging support
Window wrapper around a Menu
►Mh Mailbox
Config used by Mh
Mh-specific Mailbox data
MH local mailbox type
Mh Email helper
Definition of the Mh Module
MH Mailbox Sequences
MH shared functions
►Mutt
Linear array API
Parse a number in a string
Conversion to/from base64 encoding
Helper object for storing and parsing strings
Conversion between different character encodings
ctype(3) wrapper functions
Time and date handling routines
Private copy of the environment variables
Case-insensitive fixed-chunk comparisons
Leave the program NOW
File management functions
Pass files through external commands (filters)
Hash Table data structure
Singly-linked list type
Logging Dispatcher
Map between a string and a constant
Multi-byte String manipulation functions
Calculate the MD5 checksum of a buffer
Memory management wrappers
Definition of the Mutt Module
Notification API
Path manipulation functions
A global pool of Buffers
Manage precompiled / predefined regular expressions
Context-free sorting function
Random number/string functions
Manage regular expressions
Signal handling
A separated list of strings
Keep track when processing files
String manipulation functions
For systems lacking timegm()
For systems lacking wcscasecmp()
►Ncrypt
Config used by libncrypt
Signing/encryption multiplexor
Wrapper for PGP/SMIME calls to GPGME
Register crypto modules
Wrappers for calls to CLI PGP
Wrappers for calls to GPGME PGP
Wrappers for calls to CLI SMIME
Wrappers for calls to GPGME SMIME
Wrapper around crypto functions
GPGME Key Selection Dialog
PGP Key Selection Dialog
SMIME Key Selection Dialog
Ncrypt Expando definitions
Ncrypt Expando definitions
Ncrypt Expando definitions
Ncrypt Expando definitions
PGP/Smime functions
Parse the output of CLI PGP program
Gpgme functions
Definition of the Ncrypt Module
PGP sign, encrypt, check routines
Pgp functions
Wrapper around calls to external PGP program
PGP key management routines
Misc PGP helper routines
Identify the hash algorithm from a PGP signature
Parse PGP data packets
SMIME helper routines
Smime functions
GPGME Key Sorting
PGP Key Sorting
►Nntp
Nntp-specific Account data
Auto-complete NNTP newsgroups
Config used by libnntp
Nntp-specific Email data
Browse NNTP groups
Browse NNTP groups
Nntp-specific Mailbox data
Definition of the Nntp Module
Read/write a file of subscribed newsgroups
Talk to an NNTP server
►Notmuch
Notmuch-specific Account data
Notmuch Auto-Completion
Config used by libnotmuch
Notmuch database handling
Notmuch-specific Email data
Notmuch-specific Mailbox data
Definition of the Notmuch Module
Notmuch virtual mailbox type
Notmuch query functions
Notmuch tag functions
►Pager
Config used by libpager
Pager Display
Pager Dialog
Simple Pager Dialog
Pager functions
Process a message for display in the pager
Definition of the Pager Module
Pager Window
Pager Bar
Pager Panel
Private state data for the Pager
►Text parsing functions
Functions to parse commands in a config file
Text parser
Definition of the Parse Module
Parse Context
Parse Error
Parse lines from a config file
Parse the 'set' command
►Pattern
Compile a Pattern
Pattern Auto-Completion
Config used by libpattern
Pattern Selection Dialog
Execute a Pattern
Pattern Expando definitions
Pattern definitions
Pattern functions
Pattern handling for messages
Definition of the Pattern Module
Match patterns to emails
Private Pattern Data
Holds state of a search
►Pop
Pop-specific Account data
POP authentication
Config used by libpop
Pop-specific Email data
POP helper routines
Definition of the Pop Module
POP network mailbox
►Postponed Emails
Postponed Email Selection Dialog
Postponed Emails Functions
Definition of the Postpone Module
Postponed Email
►Progress Bar
Config used by the Progress Bar
Definition of the Progress Module
Progress Bar
Progress Bar Window Data
Progress Bar Window
►Question
Definition of the Question Module
Ask the user a question
Send Commands
►Send
Write a MIME Email to a file
Config used by libsend
Greeting Expando definitions
Message Id Expando definitions
Write a MIME Email Header to a file
Definition of the Send Module
Manipulate multipart Emails
Parse My-header Commands
Prepare and send an email
Miscellaneous functions for sending an email
Send email using sendmail
Send email to an SMTP server
►Sidebar
Sidebar commands
Config used by libsidebar
Sidebar Expando definitions
Sidebar functions
Definition of the Sidebar Module
Sidebar observers
GUI display the mailboxes in a side panel
Sidebar sort functions
Sidebar Window data
Sidebar Window
►Store
Definition of the Store Module
Shared store code
GNU dbm (GDBM)
Lightning Memory-Mapped Database (LMDB)
RocksDB
Trivial DataBase (TDB)