Mercurial > emacs
comparison lisp/mail/mh-utils.el @ 42205:7308bbc423d5
Doc fixes.
author | Pavel Janík <Pavel@Janik.cz> |
---|---|
date | Thu, 20 Dec 2001 18:59:32 +0000 |
parents | b4bc55a74924 |
children | c86cd54b5c50 |
comparison
equal
deleted
inserted
replaced
42204:73e75f765479 | 42205:7308bbc423d5 |
---|---|
114 "Format string containing a regexp matching the scan listing for a message. | 114 "Format string containing a regexp matching the scan listing for a message. |
115 The desired message's number will be an argument to format.") | 115 The desired message's number will be an argument to format.") |
116 | 116 |
117 (defcustom mhl-formfile nil | 117 (defcustom mhl-formfile nil |
118 "*Name of format file to be used by mhl to show and print messages. | 118 "*Name of format file to be used by mhl to show and print messages. |
119 A value of T means use the default format file. | 119 A value of t means use the default format file. |
120 Nil means don't use mhl to format messages when showing; mhl is still used, | 120 nil means don't use mhl to format messages when showing; mhl is still used, |
121 with the default format file, to format messages when printing them. | 121 with the default format file, to format messages when printing them. |
122 The format used should specify a non-zero value for overflowoffset so | 122 The format used should specify a non-zero value for overflowoffset so |
123 the message continues to conform to RFC 822 and mh-e can parse the headers." | 123 the message continues to conform to RFC 822 and mh-e can parse the headers." |
124 :type '(choice (const nil) (const t) string) | 124 :type '(choice (const nil) (const t) string) |
125 :group 'mh) | 125 :group 'mh) |
131 `\\[mh-refile-msg]' and `\\[mh-to-fcc]' to get a default when | 131 `\\[mh-refile-msg]' and `\\[mh-to-fcc]' to get a default when |
132 prompting the user for a folder. The function is called from within a | 132 prompting the user for a folder. The function is called from within a |
133 save-excursion, with point at the start of the message. It should | 133 save-excursion, with point at the start of the message. It should |
134 return the folder to offer as the refile or Fcc folder, as a string | 134 return the folder to offer as the refile or Fcc folder, as a string |
135 with a leading `+' sign. It can also return an empty string to use no | 135 with a leading `+' sign. It can also return an empty string to use no |
136 default, or NIL to calculate the default the usual way. | 136 default, or nil to calculate the default the usual way. |
137 NOTE: This variable is not an ordinary hook; | 137 NOTE: This variable is not an ordinary hook; |
138 It may not be a list of functions.") | 138 It may not be a list of functions.") |
139 | 139 |
140 (defvar mh-find-path-hook nil | 140 (defvar mh-find-path-hook nil |
141 "Invoked by mh-find-path while reading the user's MH profile.") | 141 "Invoked by mh-find-path while reading the user's MH profile.") |
160 (defvar mh-folder-list nil) ;List of folder names for completion. | 160 (defvar mh-folder-list nil) ;List of folder names for completion. |
161 | 161 |
162 ;; Cached value of the `Path:' component in the user's MH profile. | 162 ;; Cached value of the `Path:' component in the user's MH profile. |
163 (defvar mh-user-path nil) ;User's mail folder directory. | 163 (defvar mh-user-path nil) ;User's mail folder directory. |
164 | 164 |
165 ;; An mh-draft-folder of NIL means do not use a draft folder. | 165 ;; An mh-draft-folder of nil means do not use a draft folder. |
166 ;; Cached value of the `Draft-Folder:' component in the user's MH profile. | 166 ;; Cached value of the `Draft-Folder:' component in the user's MH profile. |
167 (defvar mh-draft-folder nil) ;Name of folder containing draft messages. | 167 (defvar mh-draft-folder nil) ;Name of folder containing draft messages. |
168 | 168 |
169 ;; Cached value of the `Unseen-Sequence:' component in the user's MH profile. | 169 ;; Cached value of the `Unseen-Sequence:' component in the user's MH profile. |
170 (defvar mh-unseen-seq nil) ;Name of the Unseen sequence. | 170 (defvar mh-unseen-seq nil) ;Name of the Unseen sequence. |
527 (format mh-msg-search-regexp n)) | 527 (format mh-msg-search-regexp n)) |
528 | 528 |
529 | 529 |
530 (defun mh-get-profile-field (field) | 530 (defun mh-get-profile-field (field) |
531 ;; Find and return the value of FIELD in the current buffer. | 531 ;; Find and return the value of FIELD in the current buffer. |
532 ;; Returns NIL if the field is not in the buffer. | 532 ;; Returns nil if the field is not in the buffer. |
533 (let ((case-fold-search t)) | 533 (let ((case-fold-search t)) |
534 (goto-char (point-min)) | 534 (goto-char (point-min)) |
535 (cond ((not (re-search-forward (format "^%s" field) nil t)) nil) | 535 (cond ((not (re-search-forward (format "^%s" field) nil t)) nil) |
536 ((looking-at "[\t ]*$") nil) | 536 ((looking-at "[\t ]*$") nil) |
537 (t | 537 (t |
846 (set-match-data prevailing-match-data)) | 846 (set-match-data prevailing-match-data)) |
847 (setq mh-folder-list-partial-line (substring output position)))) | 847 (setq mh-folder-list-partial-line (substring output position)))) |
848 | 848 |
849 | 849 |
850 (defun mh-folder-name-p (name) | 850 (defun mh-folder-name-p (name) |
851 ;; Return non-NIL if NAME is possibly the name of a folder. | 851 ;; Return non-nil if NAME is possibly the name of a folder. |
852 ;; A name (a string or symbol) can be a folder name if it begins with "+". | 852 ;; A name (a string or symbol) can be a folder name if it begins with "+". |
853 (if (symbolp name) | 853 (if (symbolp name) |
854 (eq (aref (symbol-name name) 0) ?+) | 854 (eq (aref (symbol-name name) 0) ?+) |
855 (and (> (length name) 0) | 855 (and (> (length name) 0) |
856 (eq (aref name 0) ?+)))) | 856 (eq (aref name 0) ?+)))) |