File: mairix.el.html
This is an interface to the mairix mail search engine. Mairix is written by Richard Curnow and is licensed under the GPL. See the Mairix website for details:
http://www.rpcurnow.force9.co.uk/mairix/
Features of mairix.el:
* Query mairix with a search term.
* Currently supported Emacs mail programs: RMail, Gnus (mbox only),
and VM.
* Generate search queries using graphical widgets.
* Generate search queries based on currently displayed mail.
* Save regularly used searches in your .emacs customize section.
* Major mode for viewing, editing and querying saved searches.
* Update mairix database.
Please note: There are currently no pre-defined key bindings, since I guess these would depend on the used mail program. See the docs for an overview of the provided interactive functions.
Attention Gnus users: If you use Gnus with maildir or nnml, you should use the native Gnus back end nnmairix.el instead, since it has more features and is better integrated with Gnus. This interface is essentially a stripped down version of nnmairix.el.
Currently, RMail, Gnus (with mbox files), and VM are supported as
mail programs, but it is pretty easy to interface it with other
ones as well. Please see the docs and the source for details.
In a nutshell: include your favorite mail program in
mairix-mail-program and write functions for
mairix-display-functions and mairix-get-mail-header-functions.
If you have written such functions for your Emacs mail program of
choice, please let me know, so that I can eventually include them
in future version of mairix.el.
Defined variables (20)
mairix-command | Command for calling mairix. |
mairix-customize-query-buffer | Name of the buffer for customizing a search query. |
mairix-display-functions | Specifies which function should be called for displaying search results. |
mairix-file-path | Path where output files produced by Mairix should be stored. |
mairix-get-mail-header-functions | Specifies function for obtaining a header field from the current mail. |
mairix-mail-program | Mail program used to display search results. |
mairix-output-buffer | Name of the buffer for the output of the mairix binary. |
mairix-saved-searches | Saved mairix searches. |
mairix-saved-searches-buffer | Name of the buffer for displaying saved searches. |
mairix-search-file | Name of the default file for storing the searches. |
mairix-search-history | Minibuffer history for ‘mairix-search’. |
mairix-search-options | Options when calling mairix for searching. |
mairix-searches-mode-abbrev-table | Abbrev table for ‘mairix-searches-mode’. |
mairix-searches-mode-hook | Hook run after entering ‘mairix-searches-mode’. |
mairix-searches-mode-map | ‘mairix-searches-mode’ keymap. |
mairix-synchronous-update | Defines if Emacs should wait for the mairix database update. |
mairix-update-options | Options when calling mairix for updating the database. |
mairix-widget-fields-list | Fields that should be editable during interactive query customization. |
mairix-widget-other | Other editable mairix commands when using customization widgets. |
mairix-widget-select-window-function | Function for selecting the window for customizing the mairix query. |