Function: rmail-get-summary

rmail-get-summary is a byte-compiled function defined in rmailsum.el.gz.

Signature

(rmail-get-summary MSGNUM)

Documentation

Return the summary line for message MSGNUM.

The mbox buffer must be current when you call this function even if its text is swapped.

If the message has a summary line already, it will be stored in the message as a header and simply returned, otherwise the summary line is created, saved in the message header, cached and returned.

The current buffer contains the unrestricted message collection.

Source Code

;; Defined in /usr/src/emacs/lisp/mail/rmailsum.el.gz
;; Low levels of generating a summary.

(defun rmail-get-summary (msgnum)
  "Return the summary line for message MSGNUM.
The mbox buffer must be current when you call this function
even if its text is swapped.

If the message has a summary line already, it will be stored in
the message as a header and simply returned, otherwise the
summary line is created, saved in the message header, cached and
returned.

The current buffer contains the unrestricted message collection."
  (let ((line (aref rmail-summary-vector (1- msgnum))))
    (unless line
      ;; Register a summary line for MSGNUM.
      (setq rmail-new-summary-line-count (1+ rmail-new-summary-line-count)
	    line (rmail-create-summary-line msgnum))
      ;; Cache the summary line for use during this Rmail session.
      (aset rmail-summary-vector (1- msgnum) line))
    line))