Variable: mail-directory-process

mail-directory-process is a customizable variable defined in mailalias.el.gz.

Value

nil

Documentation

Shell command to get the list of names from a mail directory.

This value is used when the value of mail-directory-function is mail-directory-process(var)/mail-directory-process(fun). The value should be a list of the form (COMMAND ARG ...), where each of the list elements is evaluated. COMMAND should evaluate to a string. When mail-directory-requery is non-nil, during evaluation of these elements, the variable pattern contains the partial input being completed. pattern is nil when mail-directory-requery is nil.

The value might look like this:

  (remote-shell-program "HOST" "-nl" "USER" "COMMAND")

or like this:

  (remote-shell-program "HOST" "-n" "COMMAND \\='^" pattern "\\='")

Probably introduced at or before Emacs version 19.31.

Source Code

;; Defined in /usr/src/emacs/lisp/mail/mailalias.el.gz
(defcustom mail-directory-process nil
  "Shell command to get the list of names from a mail directory.
This value is used when the value of `mail-directory-function'
is `mail-directory-process'.  The value should be a list
of the form (COMMAND ARG ...), where each of the list elements
is evaluated.  COMMAND should evaluate to a string.  When
`mail-directory-requery' is non-nil, during evaluation of these
elements, the variable `pattern' contains the partial input being
completed.  `pattern' is nil when `mail-directory-requery' is nil.

The value might look like this:

  (remote-shell-program \"HOST\" \"-nl\" \"USER\" \"COMMAND\")

or like this:

  (remote-shell-program \"HOST\" \"-n\" \"COMMAND \\='^\" pattern \"\\='\")"
  :type 'sexp
  :group 'mailalias)