The Mutt-Guile Automatic Reference Manual

The Mutt-Guile Automatic Reference Manual

This file documents your Guile-enabled version of Mutt. It was automatically generated by the (mutt make-doc) module (vidu Module (mutt make-doc)) based on the modules that were loaded.

• Introduction: What is this documentation about?
• Module (mutt reminders): The (mutt reminders) module
• Module (mutt aliases): The (mutt aliases) module
• Module (mutt notify): The (mutt notify) module
• Module (mutt attribution): The (mutt attribution) module
• Module (mutt mua-stats): The (mutt mua-stats) module
• Module (mutt cache): The (mutt cache) module
• Module (mutt helpers send): The (mutt helpers send) module
• Module (mutt ping): The (mutt ping) module
• Module (mutt make-doc): The (mutt make-doc) module
• Module (mutt helpers misc): The (mutt helpers misc) module
• Module (mutt sorting): The (mutt sorting) module
• Module (mutt spam): The (mutt spam) module

• Index: Guide to commands, functions and options.
• Contents: Table of contents.

Introduction

This documentation was automatically generated by the make-doc command of your Guile-enabled Mutt. It lists all modules that were loaded by Mutt at the time this command was called¹. For each module, it lists the related commands, functions and configuration options. However, Scheme procedures and options do not appear in this file.

This document was generated on Thu Nov 20 18:57:35 2003.

Module (mutt reminders)

This module defines the following reminders:

• warns you before sending a message when there are unread messages from the person you are writing to;
• warns you before sending a message if this message contains the word `attachment' or some such.

• Options for (mutt reminders): Options relevant to (mutt reminders)

Options for (mutt reminders)

attachment-regexp A regexp describing the `attachment' word.

remind-unread? When true, notifies the user of pending unread messages before sending an email.

remind-attachment? When true, notifies the user when he is about to forget an attachment.

my-stuff This option is useless.

Module (mutt aliases)

This module redefines the save-alias function so that aliases are written to files in a Schemey way.

Module (mutt notify)

Module that provides a mean of notifying you of important incoming messages by either opening a pop-up window (using xmessage(1)) or writing to your terminal (using write(1)). Note that this can be configured by redefining the notify-new-message function which takes one message object as an argument.

• Options for (mutt notify): Options relevant to (mutt notify)

Options for (mutt notify)

notify-pattern Pattern of messages for which you want to be notified.

Module (mutt attribution)

Customized message attribution line when replying to messages. Feel free to contribute with you own message attribution methods!

• Options for (mutt attribution): Options relevant to (mutt attribution)

Options for (mutt attribution)

attribution-sender-full? If "yes", write the full sender address.

builtin-attribution? If "yes", use the built-in attribution mechanism.

Module (mutt mua-stats)

Provides a command to get information about which mail-user-agent is being user by the sender of the messages available in the current mailbox. :-)

Beware: This can be really slow since each email has to be retrieved and copied to local storage!

• Commands for (mutt mua-stats): Commands defined by (mutt mua-stats)

Commands for (mutt mua-stats)

mua-stats Write mail-user-agent stats to the given file.

raw-mua-stats Write raw mail-user-agent stats to the given file, i.e. per-user stats.

Module (mutt cache)

This module provides a unified mailbox caching mechanism. What is cached is not mailbox contents themselves but rather the data structures representing it, i.e. mailbox and message objects, hash tables and so on. When opening a mailbox that has already been opened before, those data structures are directly reused, whithout having to re-read the whole mailbox, sort and score messages, etc. This makes switching from one box to another much faster, and not only for network mailboxes like IMAP and POP3.

Since it is sometimes not desirable to cache mailboxes this way, you may define which mailboxes should not be cached by setting the non-cacheable-mailboxes-regexp regexp, or by overloading the cacheable-mailbox? procedure.

Alternatively, the provided switch command implements a mailbox stack that may be used in lieu of the unified cache mechanism when switching from one mailbox to another.

• Commands for (mutt cache): Commands defined by (mutt cache)
• Options for (mutt cache): Options relevant to (mutt cache)

Commands for (mutt cache)

cache-purge Purge the mailbox cache.

switch Switch to the given mailbox or quickly switch back to the previous one.

Options for (mutt cache)

non-cacheable-mailboxes-regexp Mailboxes whose name matches this regexp are not cached.

cache-enabled? Tells whether mailbox caching should be used.

check-cached-mailboxes? Tells whether cached mailboxes should be periodically checked. Useful for IMAP mailboxes.

Module (mutt helpers send)

Helper functions for preparing and sending messages.

Module (mutt ping)

This module enables automagic reply to incoming messages whose subject is equal to ping-subject. Yeah, this is one of my favorites. :-)

• Options for (mutt ping): Options relevant to (mutt ping)

Options for (mutt ping)

ping-enabled? Tells whether the ping feature is enabled.

ping-reply-subject Ping reply message subject.

ping-show-unread-messages? If true, tell the sender of the ping message how many pending unread messages from him you have.

ping-command Command whose output is directed to $ping-file-name.

ping-include-body? Tells whether the original message body should be included in the reply message

ping-subject Ping message subject.

pong-subject Ping reply message subject.

ping-file-name Name of the file containing the ping reply.

Module (mutt make-doc)

The (mutt make-doc) module provides commands to automatically generate GNU Texinfo documentation files for the modules loaded at the time the command is invoked. The makeinfo program (from the GNU Texinfo package) may then be used to produce documentation in various formats including Info, HTML, and DocBook.

• Commands for (mutt make-doc): Commands defined by (mutt make-doc)
• Options for (mutt make-doc): Options relevant to (mutt make-doc)

Commands for (mutt make-doc)

make-doc Output to the given file a Texinfo documentation of available commands, functions and options.

make-texi-doc Output to the given file a Texinfo documentation of available commands, functions and options.

make-html-doc Output to the given file a HTML documentation of available commands, functions and options.

make-info-doc Output to the given file an info documentation of available commands, functions and options.

Options for (mutt make-doc)

makeinfo-command Command to run `makeinfo' (from GNU Texinfo).

Module (mutt helpers misc)

Miscellaneous helper functions.

Module (mutt sorting)

This module automates mailing-list messages sorting. The sorted-lists Scheme variable, an alist of pattern/mailbox-name pairs, should be defined by the user in order for the module to know which messages (i.e. messages matching which pattern) should go where (i.e. in which mailbox). Pattern/mailbox-name pairs may also be added to sorted-lists using the sort-list command.

The move may be executed in order for messages to be sorted according to sorted-lists. Alternatively, sorting may be performed automatically every auto-sort-frequency minutes for messages that are read and older than auto-sort-days.

• Commands for (mutt sorting): Commands defined by (mutt sorting)
• Options for (mutt sorting): Options relevant to (mutt sorting)

Commands for (mutt sorting)

auto-list-sort Autosorting of mailing lists messages older than auto-sort-days days.

sort-list Sort messages matching the pattern given as the first argument to the mailbox whose path was passed as the second argument.

move Move mailing-list messages to the appropriate mailbox.

Options for (mutt sorting)

auto-sort-enabled? If "yes", mailing-list auto-sorting is enabled.

auto-sort-initial-delay Tells how long (minutes) auto-sorting should wait before being executed for the first time.

auto-sort-days Number of days after which a message can get sorted out.

auto-sort-frequency Tells how often (minutes) messages auto-sorting should be performed. Note that the actual frequency depends on the value of the timeout option.

Module (mutt spam)

Spam checking and learning module.

Run a spam filter (typically Bogofilter - SpamAssassin could make it but is too slow) on each viewed message and allow the user to teach it what spam is.

• Options for (mutt spam): Options relevant to (mutt spam)

Options for (mutt spam)

learn-spam? Each time a mail is considered as ham, ask the user whether it really is ham.

spam-check-command Command to pipe messages through when checking spamity.

spam-learn-ham-command Command to tell the spam filter that an email is non-spam.

spam-learn-spam-command Command to tell the spam filter that an email is spam.

spam-mailbox Mailbox where spam should be saved when spam-auto-filter? is enabled.

spam-auto-filter? If true, automatic filtering of incoming messages is enabled, provided learn-ham? is false. Note that this is independent from the value of spam-check-enabled?.

spam-checker-positive-exit-value The exit value of the spam filter for messages considered as spam.

learn-ham? Each time a mail is considered as spam, ask the user whether it really is spam.

spam-check-enabled? Tells whether messages should be checked before being displayed.

Index

Contents