summaryrefslogtreecommitdiff
path: root/lisp/mail/mail-utils.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2009-01-31 02:52:18 +0000
committerGlenn Morris <rgm@gnu.org>2009-01-31 02:52:18 +0000
commit78f086e42cea8d7df52d5c617d18cfa41036adda (patch)
tree659764d287c8415e9df1f00d04e9a3b386abd922 /lisp/mail/mail-utils.el
parent603c5d8d67c202f99262acb7b569ca9c2203c48f (diff)
downloademacs-78f086e42cea8d7df52d5c617d18cfa41036adda.tar.gz
(mail-fetch-field): Doc fix.
Diffstat (limited to 'lisp/mail/mail-utils.el')
-rw-r--r--lisp/mail/mail-utils.el9
1 files changed, 5 insertions, 4 deletions
diff --git a/lisp/mail/mail-utils.el b/lisp/mail/mail-utils.el
index f939f19d06c..2268e1e68f8 100644
--- a/lisp/mail/mail-utils.el
+++ b/lisp/mail/mail-utils.el
@@ -1,7 +1,7 @@
;;; mail-utils.el --- utility functions used both by rmail and rnews
-;; Copyright (C) 1985, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
+;; 2009 Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: mail, news
@@ -302,10 +302,11 @@ the comma-separated list. The pruned list is returned."
;;;###autoload
(defun mail-fetch-field (field-name &optional last all list)
"Return the value of the header field whose type is FIELD-NAME.
-The buffer is expected to be narrowed to just the header of the message.
If second arg LAST is non-nil, use the last field of type FIELD-NAME.
If third arg ALL is non-nil, concatenate all such fields with commas between.
-If 4th arg LIST is non-nil, return a list of all such fields."
+If 4th arg LIST is non-nil, return a list of all such fields.
+The header must be at the start of the buffer. If any of the optional
+arguments are used, the buffer should be narrowed to just the header."
(save-excursion
(goto-char (point-min))
(let ((case-fold-search t)