File: mh-e.el.html

MH-E is an Emacs interface to the MH mail system.

MH-E is compatible with MH versions 6.8.4 and higher, all versions of nmh, and GNU mailutils 1.0 and higher.

MH (Message Handler) is a powerful mail reader. See https://rand-mh.sourceforge.io/.

N.B. MH must have been compiled with the MHE compiler flag or several features necessary for MH-E will be missing from MH commands, specifically the -build switch to repl and forw.

How to use:
  M-x mh-rmail to read mail. Type C-h m there for a list of commands.
  C-u M-x mh-rmail to visit any folder.
  M-x mh-smail to send mail. From within the mail reader, "s" works, too.

Your .emacs might benefit from these bindings:
  (global-set-key "\\C-cr" 'mh-rmail)
  (global-set-key "\\C-xm" 'mh-smail)
  (global-set-key "\\C-x4m" 'mh-smail-other-window)

Mailing Lists:
  mh-e-users@lists.sourceforge.net
  mh-e-announce@lists.sourceforge.net
  mh-e-devel@lists.sourceforge.net

  Subscribe by sending a "subscribe" message to
  <list>-request@lists.sourceforge.net, or by using the web interface at
  https://sourceforge.net/mail/?group_id=13357

Bug Reports:
  https://sourceforge.net/tracker/?group_id=13357&atid=113357
  Include the output of M-x mh-version in the bug report unless
  you're 110% sure we won't ask for it.

Feature Requests:
  https://sourceforge.net/tracker/?group_id=13357&atid=363357

Support:
  https://sourceforge.net/tracker/?group_id=13357&atid=213357

Defined variables (167)

mh-adaptive-cmd-note-flagNon-nil means that the message number width is determined dynamically.
mh-after-commands-processed-hookHook run by x after performing outstanding refile and delete requests.
mh-alias-completion-ignore-case-flagNon-nil means don’t consider case significant in MH alias completion.
mh-alias-expand-aliases-flagNon-nil means to expand aliases entered in the minibuffer.
mh-alias-flash-on-commaSpecify whether to flash address or warn on translation.
mh-alias-insert-fileFilename used to store a new MH-E alias.
mh-alias-insertion-locationSpecifies where new aliases are entered in alias files.
mh-alias-local-usersNon-nil means local users are added to alias completion.
mh-alias-local-users-prefixString prefixed to the real names of users from the password file.
mh-alias-passwd-gecos-comma-separator-flagNon-nil means the gecos field in the password file uses a comma separator.
mh-alias-reloaded-hookHook run by ‘mh-alias-reload’ after loading aliases.
mh-allowlistList of messages to use to train the junk filter.
mh-allowlist-msg-hookHook run by M-x mh-junk-allowlist after marking each message for allowlisting.
mh-allowlist-preserves-sequences-flagNon-nil means that sequences are preserved when messages are allowlisted.
mh-annotate-msg-hookHook run when a message is sent and after annotating the scan lines and message.
mh-arrow-markerMarker for arrow display in fringe.
mh-auto-fields-listList of recipients for which header lines are automatically inserted.
mh-auto-fields-prompt-flagNon-nil means to prompt before sending if fields inserted.
mh-before-commands-processed-hookHook run by x before performing outstanding refile and delete requests.
mh-before-quit-hookHook run by q before quitting MH-E.
mh-before-send-letter-hookHook run at the beginning of the C-c C-c command.
mh-blocklistList of messages to use to train the junk filter.
mh-blocklist-msg-hookHook run by M-x mh-junk-blocklist after marking each message for blocklisting.
mh-bury-show-buffer-flagNon-nil means show buffer is buried.
mh-clean-message-header-flagNon-nil means remove extraneous header fields.
mh-colors-available-flagNon-nil means colors are available.
mh-compose-forward-as-mime-flagNon-nil means that messages are forwarded as attachments.
mh-compose-insertionType of tags used when composing MIME messages.
mh-compose-letter-functionInvoked when starting a new draft.
mh-compose-prompt-flagNon-nil means prompt for header fields when composing a new draft.
mh-compose-skipped-header-fieldsList of header fields to skip over when navigating in draft.
mh-compose-space-does-completion-flagNon-nil means SPC does completion in message header.
mh-current-folderName of current folder, a string.
mh-decode-mime-flagNon-nil means attachments are handled.
mh-default-folder-for-message-functionFunction to select a default folder for refiling or "Fcc:".
mh-default-folder-listList of addresses and folders.
mh-default-folder-must-exist-flagNon-nil means guessed folder name must exist to be used.
mh-default-folder-prefixPrefix used for folder names generated from aliases.
mh-delay-invisible-header-generation-flagNon-nil means to delay the generation of invisible header fields.
mh-delete-listList of message numbers to delete.
mh-delete-msg-hookHook run by M-x mh-delete-msg after marking each message for deletion.
mh-delete-yanked-msg-window-flagNon-nil means delete any window displaying the message.
mh-display-buttons-for-alternatives-flagNon-nil means display buttons for all alternative attachments.
mh-display-buttons-for-inline-parts-flagNon-nil means display buttons for all inline attachments.
mh-do-not-confirm-flagNon-nil means non-reversible commands do not prompt for confirmation.
mh-draft-folderCached value of the "Draft-Folder:" MH profile component.
mh-extract-from-attribution-verbVerb to use for attribution when a message is yanked by C-c C-y.
mh-face-dataMH-E face data.
mh-fetch-x-image-urlControl fetching of "X-Image-URL:" header field image.
mh-find-path-hookHook run by ‘mh-find-path’ after reading the user’s MH profile.
mh-flists-present-flagNon-nil means that we have "flists".
mh-folder-seq-tool-bar-mapKeymap for MH-Folder tool bar.
mh-folder-tool-bar-mapKeymap for MH-Folder tool bar.
mh-folder-view-stackStack of previous folder views.
mh-folders-changedLists which folders were affected by deletes and refiles.
mh-forward-hookHook run by ‘mh-forward’ on a forwarded letter.
mh-forward-subject-formatFormat string for forwarded message subject.
mh-globals-hashKeeps track of MIME data on a per buffer basis.
mh-graphical-emphasis-flagNon-nil means graphical emphasis is displayed.
mh-graphical-smileys-flagNon-nil means graphical smileys are displayed.
mh-highlight-citation-styleStyle for highlighting citations.
mh-identity-defaultDefault identity to use when ‘mh-letter-mode’ is called.
mh-identity-handlersHandler functions for fields in ‘mh-identity-list’.
mh-identity-listList of identities.
mh-inboxCached value of the "Inbox:" MH profile component.
mh-inc-folder-hookHook run by i after incorporating mail into a folder.
mh-inc-progProgram to incorporate new mail into a folder.
mh-inc-spool-listAlternate spool files.
mh-inc-spool-mapKeymap for MH-E’s mh-inc-spool commands.
mh-index-dataInfo about index search results.
mh-index-data-fileMH-E specific file where index search info is stored.
mh-index-max-cmdline-argsMaximum number of command line args.
mh-inherit-face-flagNon-nil means that the ‘defface’ :inherit keyword is available.
mh-ins-buf-prefixString to put before each line of a yanked or inserted message.
mh-insert-signature-hookHook run by C-c C-s after signature has been inserted.
mh-insert-x-mailer-flagNon-nil means append an "X-Mailer:" header field to the header.
mh-interpret-number-as-range-flagNon-nil means interpret a number as a range.
mh-invisible-header-fieldsAdditional header fields to hide.
mh-invisible-header-fields-compiledRegexp matching lines in a message header that are not to be shown.
mh-invisible-header-fields-defaultList of hidden header fields.
mh-invisible-header-fields-internalList of default header fields that are not to be shown.
mh-junk-backgroundIf on, spam programs are run in background.
mh-junk-choiceChosen spam fighting program.
mh-junk-dispositionDisposition of junk mail.
mh-junk-function-alistAvailable choices of spam programs to use.
mh-junk-programSpam program that MH-E should use.
mh-kill-folder-suppress-prompt-functionsAbnormal hook run at the beginning of F k.
mh-kill-folder-suppress-prompt-hooksAbnormal hook run at the beginning of F k.
mh-large-folderThe number of messages that indicates a large folder.
mh-letter-complete-functionFunction to call when completing outside of address or folder fields.
mh-letter-fill-columnFill column to use in MH Letter mode.
mh-letter-tool-bar-mapKeymap for MH-Letter tool bar.
mh-libDirectory containing the MH library.
mh-lib-progsDirectory containing MH helper programs.
mh-lpr-command-formatCommand used to print.
mh-mail-header-separatorLine used by MH to separate headers from text in messages being composed.
mh-max-inline-image-heightMaximum inline image height if "Content-Disposition:" is not present.
mh-max-inline-image-widthMaximum inline image width if "Content-Disposition:" is not present.
mh-mh-to-mime-hookHook run on the formatted letter by C-c C-e.
mh-mhl-format-fileSpecifies the format file to pass to the "mhl" program.
mh-mime-save-parts-default-directoryDefault directory to use for K a.
mh-min-colors-defined-flagNon-nil means ‘defface’ supports min-colors display requirement.
mh-mml-method-defaultDefault method to use in security tags.
mh-mode-line-annotationMessage range displayed in buffer.
mh-new-messages-foldersFolders searched for the "unseen" sequence.
mh-next-directionDirection to move to next message.
mh-pack-folder-hookHook run by F p after renumbering the messages.
mh-page-to-next-msg-flagNon-nil means next SPC or whatever goes to next undeleted message.
mh-pathAdditional list of directories to search for MH.
mh-pgp-support-flagNon-nil means PGP support is available.
mh-previous-seqCached value of the "Previous-Sequence:" MH profile component.
mh-previous-window-configWindow configuration before MH-E command.
mh-print-background-flagNon-nil means messages should be printed in the background.
mh-progsDirectory containing MH commands, such as inc, repl, and rmm.
mh-quit-hookHook run by q after quitting MH-E.
mh-recenter-summary-flagNon-nil means to recenter the summary window.
mh-recursive-folders-flagNon-nil means that commands which operate on folders do so recursively.
mh-redist-full-contents-flagNon-nil means the "dist" command needs entire letter for redistribution.
mh-refile-listList of folder names in ‘mh-seq-list’.
mh-refile-msg-hookHook run by o after marking each message for refiling.
mh-refile-preserves-sequences-flagNon-nil means that sequences are preserved when messages are refiled.
mh-reply-default-reply-toSets the person or persons to whom a reply will be sent.
mh-reply-show-message-flagNon-nil means the MH-Show buffer is displayed when replying.
mh-scan-format-fileSpecifies the format file to pass to the scan program.
mh-scan-progProgram used to scan messages.
mh-search-programSearch program that MH-E shall use.
mh-seen-listList of displayed messages to be removed from the "Unseen" sequence.
mh-sent-from-folderFolder of msg assoc with this letter.
mh-sent-from-msgNumber of msg assoc with this letter.
mh-seq-listAlist of this folder’s sequences.
mh-sequence-notation-historyRemember original notation that is overwritten by ‘mh-note-seq’.
mh-show-bufferBuffer that displays message for this folder.
mh-show-folder-bufferKeeps track of folder whose message is being displayed.
mh-show-hookHook run after RET shows a message.
mh-show-maximum-sizeMaximum size of message (in bytes) to display automatically.
mh-show-seq-tool-bar-mapKeymap for MH-Show tool bar.
mh-show-threads-flagNon-nil means new folders start in threaded mode.
mh-show-tool-bar-mapKeymap for MH-Show tool bar.
mh-show-use-xface-flagNon-nil means display face images in MH-show buffers.
mh-showing-modeNon-nil if Mh-Showing mode is enabled.
mh-showing-mode-hookHook run after entering or leaving ‘mh-showing-mode’.
mh-signature-file-nameSource of user’s signature.
mh-signature-separatorText of a signature separator.
mh-signature-separator-flagNon-nil means a signature separator should be inserted.
mh-signature-separator-regexpThis regular expression matches the signature separator.
mh-sortm-argsAdditional arguments for "sortm".
mh-speed-update-intervalTime between speedbar updates in seconds.
mh-store-default-directoryDefault directory for X u.
mh-summary-heightNumber of lines in MH-Folder buffer (including the mode line).
mh-sys-pathList of directories to search for variants of the MH variant.
mh-thread-scan-line-mapMap of message index to various parts of the scan line.
mh-thread-scan-line-map-stackOld map of message index to various parts of the scan line.
mh-tick-seqThe name of the MH sequence for ticked messages.
mh-ticked-messages-foldersFolders searched for ‘mh-tick-seq’.
mh-tool-bar-search-functionFunction called by the tool bar search button.
mh-unseen-seqCached value of the "Unseen-Sequence:" MH profile component.
mh-unseen-updated-hookHook run after the unseen sequence has been updated.
mh-update-sequences-after-mh-show-flagNon-nil means flush MH sequences to disk after message is shown.
mh-user-pathCached value of the "Path:" MH profile component.
mh-variantSpecifies the variant used by MH-E.
mh-variant-in-useThe MH variant currently in use; a string with variant and version number.
mh-variantsList describing known MH variants.
mh-versionVersion number of MH-E.
mh-view-opsStack of operations that change the folder view.
mh-x-face-fileFile containing face header field to insert in outgoing mail.
mh-x-mailer-stringString containing the contents of the X-Mailer header field.
mh-yank-behaviorControls which part of a message is yanked by C-c C-y.

Defined functions (39)

defcustom-mh(SYMBOL VALUE DOC &rest ARGS)
defface-mh(FACE SPEC DOC &rest ARGS)
defgroup-mh(SYMBOL MEMBERS DOC &rest ARGS)
mh-adaptive-cmd-note-flag-check(SYMBOL VALUE)
mh-customize(&optional DELETE-OTHER-WINDOWS-FLAG)
mh-exchange-point-and-mark-preserving-active-mark()
mh-exec-cmd(COMMAND &rest ARGS)
mh-exec-cmd-daemon(COMMAND FILTER &rest ARGS)
mh-exec-cmd-env-daemon(ENV COMMAND FILTER &rest ARGS)
mh-exec-cmd-error(ENV COMMAND &rest ARGS)
mh-exec-cmd-output(COMMAND DISPLAY &rest ARGS)
mh-exec-cmd-quiet(RAISE-ERROR COMMAND &rest ARGS)
mh-exec-lib-cmd-output(COMMAND &rest ARGS)
mh-face-data(FACE &optional INHERIT)
mh-file-command-p(FILE)
mh-handle-process-error(COMMAND STATUS)
mh-invisible-headers()
mh-junk-choose(SYMBOL VALUE)
mh-list-to-string(L)
mh-list-to-string-1(L)
mh-macro-expansion-time-gnus-version()
mh-process-daemon(PROCESS OUTPUT)
mh-profile-component(COMPONENT)
mh-profile-component-value(COMPONENT)
mh-quote-for-shell(STRING)
mh-run-time-gnus-version()
mh-scan-format-file-check(SYMBOL VALUE)
mh-showing-mode(&optional ARG)
mh-strip-package-version(ARGS)
mh-variant-gnu-mh-info(DIR)
mh-variant-info(DIR)
mh-variant-mh-info(DIR)
mh-variant-nmh-info(DIR)
mh-variant-p(&rest VARIANTS)
mh-variant-set(VARIANT)
mh-variant-set-variant(VARIANT)
mh-variants()
mh-version()
mh-xargs(CMD &rest ARGS)

Defined faces (31)

mh-folder-addressRecipient face.
mh-folder-allowlistedAllowlisted message face.
mh-folder-blocklistedBlocklisted message face.
mh-folder-bodyBody text face.
mh-folder-cur-msg-numberCurrent message number face.
mh-folder-dateDate face.
mh-folder-deletedDeleted message face.
mh-folder-followup"Re:" face.
mh-folder-msg-numberMessage number face.
mh-folder-refiledRefiled message face.
mh-folder-sent-to-me-hintFontification hint face in messages sent directly to us. The detection of messages sent to us is governed by the scan format `mh-scan-format-nmh' and the regular expression `mh-scan-sent-to-me-sender-regexp'.
mh-folder-sent-to-me-senderSender face in messages sent directly to us. The detection of messages sent to us is governed by the scan format `mh-scan-format-nmh' and the regular expression `mh-scan-sent-to-me-sender-regexp'.
mh-folder-subjectSubject face.
mh-folder-tickTicked message face.
mh-folder-to"To:" face.
mh-letter-header-fieldEditable header field value face in draft buffers.
mh-search-folderFolder heading face in MH-Folder buffers created by searches.
mh-show-ccFace used to highlight "cc:" header fields.
mh-show-dateFace used to highlight "Date:" header fields.
mh-show-fromFace used to highlight "From:" header fields.
mh-show-headerFace used to deemphasize less interesting header fields.
mh-show-pgg-badBad PGG signature face.
mh-show-pgg-goodGood PGG signature face.
mh-show-pgg-unknownUnknown or untrusted PGG signature face.
mh-show-signatureSignature face.
mh-show-subjectFace used to highlight "Subject:" header fields.
mh-show-toFace used to highlight "To:" header fields.
mh-speedbar-folderBasic folder face.
mh-speedbar-folder-with-unseen-messagesFolder face when folder contains unread messages.
mh-speedbar-selected-folderSelected folder face.
mh-speedbar-selected-folder-with-unseen-messagesSelected folder face when folder contains unread messages.