| blob | 5153921a8da878ec89b0db5b8b62c7e67f37aea5 |
1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2002
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;;; Code:
43 "Reading mail with Gnus."
47 "Retrieving new mail."
51 "Preparing (or mangling) new mail after retrival."
55 "Handling of duplicate mail messages."
59 "Organizing the incoming mail in folders."
63 "Mail files."
68 "Expiring old mail."
72 "Interfacing with procmail and other mail agents."
76 "Various mail options."
81 "*Incoming mail will be split according to this variable.
83 If you'd like, for instance, one mail group for mail from the
85 else, you could do something like this:
87 (setq nnmail-split-methods
92 As you can see, this variable is a list of lists, where the first
96 nnmail will try to match on the header to find a fit.
98 The second element can also be a function. In that case, it will be
99 called narrowed to the headers with the first element of the rule as
100 the argument. It should return a non-nil value if it thinks that the
101 mail belongs in that group.
105 This variable can also have a function as its value."
111 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
113 "If non-nil, do crossposting if several split methods match the mail.
114 If nil, the first match found will be used."
118 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
120 "If non-nil, nnmail will never delete/move a group's last article.
121 It can be marked expirable, so it will be deleted when it is no longer last.
123 You may need to set this variable if other programs are putting
124 new mail into folder numbers that Gnus has marked as expired."
130 "If non-nil the mail backends will use long file and directory names.
137 "Set the mode bits of all new mail files to this integer."
142 "*Expirable articles that are older than this will be expired.
143 This variable can either be a number (which will be interpreted as a
144 number of days) -- this doesn't have to be an integer. This variable
145 can also be `immediate' and `never'."
152 "Variable that holds function to specify how old articles should be before they are expired.
153 The function will be called with the name of the group that the
154 expiry is to be performed in, and it should return an integer that
155 says how many days an article can be stored before it is considered
158 Eg.:
160 \(setq nnmail-expiry-wait-function
161 (lambda (newsgroup)
165 (t 7))))"
171 "*Variable that says where expired messages should end up.
172 The default value is `delete' (which says to delete the messages),
173 but it can also be a string or a function. If it is a string, expired
174 messages end up in that group. If it is a function, the function is
175 called in a buffer narrowed to the message in question. The function
176 receives one argument, the name of the group the message comes from.
177 The return value should be `delete' or a group name (a string)."
182 string))
185 "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache."
190 "*Where the mail backends will look for incoming mail.
191 This variable is a list of mail source specifiers.
192 This variable is obsolete; `mail-sources' should be used instead."
197 "*If non-nil, re-split incoming procmail sorted mail."
202 "*If non-nil, scan all incoming procmail sorted mails once.
203 It scans low-level sorted spools even when not required."
209 "Function called to delete files in some mail backends."
215 'copy-file
217 "*Function called to create a copy of a file.
218 This is `add-name-to-file' by default, which means that crossposts
219 will use hard links. If your file system doesn't allow hard
220 links, you could set this variable to `copy-file' instead."
229 nil)
230 "*Hook that will be run after the incoming mail has been transferred.
231 The incoming mail is moved from the specified spool file (which normally is
233 directory. This hook is called after the incoming mail box has been
234 emptied, and can be used to call any mail box programs you have
237 Eg.
239 \(add-hook 'nnmail-read-incoming-hook
240 (lambda ()
244 If you have xwatch running, this will alert it that mail has been
245 read.
247 If you use `display-time', you could use something like this:
249 \(add-hook 'nnmail-read-incoming-hook
250 (lambda ()
251 ;; Update the displayed time, since that will clear out
252 ;; the flag that says you have mail.
259 "Hook called before treating incoming mail.
260 The hook is run in a buffer with all the new, incoming mail."
265 "Hook called narrowed to the headers of each message.
266 This can be used to remove excessive spaces (and stuff like
267 that) from the headers before splitting and saving the messages."
272 "Hook called narrowed to each message."
277 "Regexp that matches list identifiers to be removed.
278 This can also be a list of regexps."
285 "Hook called just before starting to handle new incoming mail."
290 "Hook called just after finishing handling new incoming mail."
295 "Hook called before deciding where to split an article.
296 The functions in this hook are free to modify the buffer
297 contents in any way they choose -- the buffer contents are
298 discarded after running the split process."
303 "*The number of the articles which indicates a large newsgroup.
304 If the number of the articles is greater than the value, verbose
305 messages will be shown to indicate the current status."
310 "Incoming mail can be split according to this fancy variable.
311 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
313 The format of this variable is SPLIT, where SPLIT can be one of
314 the following:
316 GROUP: Mail will be stored in GROUP (a string).
318 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
319 field FIELD (a regexp) contains VALUE (a regexp), store the messages
320 as specified by SPLIT. If RESTRICT (a regexp) matches some string
321 after FIELD and before the end of the matched VALUE, return nil,
322 otherwise process SPLIT. Multiple RESTRICTs add up, further
323 restricting the possibility of processing SPLIT.
325 \(| SPLIT...): Process each SPLIT expression until one of them matches.
326 A SPLIT expression is said to match if it will cause the mail
327 message to be stored in one or more groups.
329 \(& SPLIT...): Process each SPLIT expression.
331 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
332 the buffer containing the message headers. The return value FUNCTION
333 should be a split, which is then recursively processed.
335 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
336 return value FUNCTION should be a split, which is then recursively
337 processed.
339 FIELD must match a complete field name. VALUE must match a complete
340 word according to the `nnmail-split-fancy-syntax-table' syntax table.
343 FIELD and VALUE can also be lisp symbols, in that case they are expanded
344 as specified in `nnmail-split-abbrev-alist'.
349 Example:
351 \(setq nnmail-split-methods 'nnmail-split-fancy
352 nnmail-split-fancy
353 ;; Messages from the mailer daemon are not crossposted to any of
354 ;; the ordinary groups. Warnings are put in a separate group
355 ;; from real errors.
358 ;; Non-error messages are crossposted to all relevant
359 ;; groups, but we don't crosspost between the group for the
360 ;; (ding) list and the group for other (ding) related mail.
363 ;; Other mailing lists...
366 ;; Both lists below have the same suffix, so prevent
367 ;; cross-posting to mkpkg.list of messages posted only to
368 ;; the bugs- list, but allow cross-posting when the
369 ;; message was really cross-posted.
372 ;;
373 ;; People...
375 ;; Unmatched mail goes to the catch all group.
378 ;; Sigh!
388 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
393 "*The approximate number of Message-IDs nnmail will keep in its cache.
394 If this variable is nil, no checking on duplicate messages will be
395 performed."
401 "*The file name of the nnmail Message-ID cache."
407 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
408 Three values are valid: nil, which means that nnmail is not to keep a
409 Message-ID cache; `warn', which means that nnmail should insert extra
410 headers to warn the user about the duplication (this is the default);
411 and `delete', which means that nnmail will delete duplicated mails.
413 This variable can also be a function. It will be called from a buffer
414 narrowed to the article in question with the Message-ID as a
415 parameter. It should return nil, `warn' or `delete'."
422 "*Extra headers to parse."
428 "Header lines longer than this limit are excluded from the split function."
433 ;;; Internal variables.
443 ;; support the %-hack
452 \f
457 \f
466 mm-text-coding-system
473 "Insert FILE in server buffer safely."
483 t)
487 "Make file name for GROUP."
492 ?. ?_))
494 ;; If this directory exists, we use it directly.
499 ;; If not, we translate dots into slashes.
503 nnmail-pathname-coding-system)
504 dir))))
508 "Returns an assoc of group names and active ranges.
509 nn*-request-list should have been called before calling this function."
510 ;; Go through all groups from the active list.
516 "Parse the active file in the current buffer and return an alist."
524 group-assoc group max min)
535 group-assoc)))
539 group-assoc))
545 "Save GROUP-ASSOC in ACTIVE-FILE."
552 "Generate an active file from group-alist ALIST."
563 "Find out whether this FILE is to be split into GROUP only.
564 If SOURCE is a directory spec, try to return the group name component."
570 nil)))
571 nil))
576 start message-id content-length do-search end)
586 ;; Skip all the headers in case there are more "From "s...
591 ;; Unquote the ">From " line, if any.
597 ;; Find the Message-ID header.
603 ;; There is no Message-ID here, so we create one.
611 ;; Look for a Content-Length header.
619 ;; We destroy the header, since none of
620 ;; the backends ever use it, and we do not
621 ;; want to confuse other mailers by having
622 ;; a (possibly) faulty header.
635 ;; Go to the beginning of the next article - or to the end
636 ;; of the buffer.
650 count))
653 "Put point at the beginning of the next Unix mbox message."
654 ;; Algorithm used to find the next article in the
655 ;; brain-dead Unix mbox format:
656 ;;
657 ;; 1) Search for "^From ".
658 ;; 2) If we find it, then see whether the previous
659 ;; line is blank and the next line looks like a header.
660 ;; Then it's possible that this is a mail delim, and we use it.
662 found)
682 "Put point at the beginning of the current Unix mbox message."
683 ;; Algorithm used to find the next article in the
684 ;; brain-dead Unix mbox format:
685 ;;
686 ;; 1) Search for "^From ".
687 ;; 2) If we find it, then see whether the previous
688 ;; line is blank and the next line looks like a header.
689 ;; Then it's possible that this is a mail delim, and we use it.
691 found)
713 start message-id content-length end skip head-end)
717 ;; Possibly wrong format?
719 ;; Carry on until the bitter end.
722 end nil)
723 ;; Find the end of the head.
725 start
728 ;; This will never happen, but just to be on the safe side --
729 ;; if there is no head-body delimiter, we search a bit manually.
734 ;; Find the Message-ID header.
742 ;; There is no Message-ID here, so we create one.
745 ;; Look for a Content-Length header.
751 ;; We destroy the header, since none of the backends ever
752 ;; use it, and we do not want to confuse other mailers by
753 ;; having a (possibly) faulty header.
757 ;; Find the end of this article.
761 ;; We try the Content-Length value. The idea: skip over the header
762 ;; separator, then check what happens content-length bytes into the
763 ;; message body. This should be either the end of the buffer, the
764 ;; message separator or a blank line followed by the separator.
765 ;; The blank line should probably be deleted. If neither of the
766 ;; three is met, the content-length header is probably invalid.
781 ;; No Content-Length, so we find the beginning of the next
782 ;; article or the end of the buffer.
786 ;; Allow the backend to save the article.
795 count))
801 start message-id end)
805 ;; Possibly wrong format?
807 ;; Carry on until the bitter end.
810 ;; Find the end of the head.
812 start
815 ;; This will never happen, but just to be on the safe side --
816 ;; if there is no head-body delimiter, we search a bit manually.
821 ;; Find the Message-ID header.
825 ;; There is no Message-ID here, so we create one.
833 ;; Find the end of this article.
839 ;; Allow the backend to save the article.
849 count))
852 ;; In a maildir, every file contains exactly one mail.
854 message-id)
856 ;; Find the end of the head.
861 ;; This will never happen, but just to be on the safe side --
862 ;; if there is no head-body delimiter, we search a bit manually.
867 ;; Find the Message-ID header.
871 ;; There is no Message-ID here, so we create one.
879 ;; Allow the backend to save the article.
887 group artnum-func)
888 "Go through the entire INCOMING file and pick out each individual mail.
889 FUNC will be called with the buffer narrowed to each mail."
891 ;; methods to just this group.
895 nnmail-split-methods)))
897 ;; Insert the incoming file.
904 0
907 ;; Handle both babyl, MMDF and unix mail formats, since
908 ;; movemail will use the former when fetching from a
909 ;; mailbox, the latter when fetching from a file.
924 "Look at the headers and return an alist of groups that match.
925 FUNC will be called with the group name to determine the article number."
929 end group-art method grp)
932 ;; If there is only just one group to put everything in, we
933 ;; just return a list with just this one method in.
936 ;; We do actual comparison.
938 ;; Find headers.
943 ;; Copy the headers into the work buffer.
945 ;; Fold continuation lines.
949 ;; Nuke pathologically long headers. Since Gnus applies
950 ;; pathologically complex regexps to the buffer, lines
951 ;; that are looong will take longer than the Universe's
952 ;; existence to process.
956 nnmail-split-header-length-limit)
959 ;; Allow washing.
968 ;; `nnmail-split-methods' is a function, so we
969 ;; just call this function here and use the
970 ;; result.
979 ;; The article may be "cross-posted" to `junk'. What
980 ;; to do? Just remove the `junk' spec. Don't really
981 ;; see anything else to do...
989 split))))
990 ;; Go through the split methods to find a match.
1004 nil t)))
1007 pos)
1008 ;; Function to say whether this is a match.
1010 ;; Don't enter the article into the same
1011 ;; group twice.
1014 group-art))
1015 ;; This is the final group, which is used as a
1016 ;; catch-all.
1021 ;; Produce a trace if non-empty.
1033 ;; See whether the split methods returned `junk'.
1035 nil
1036 ;; The article may be "cross-posted" to `junk'. What
1037 ;; to do? Just remove the `junk' spec. Don't really
1038 ;; see anything else to do...
1045 "Insert how many lines there are in the body of the mail.
1046 Return the number of characters in the body."
1061 chars)))
1064 "Insert an Xref line based on the (group . article) alist."
1079 nnmail-pathname-coding-system)
1084 ;;; Message washing functions
1087 "Remove excessive whitespace from all headers."
1093 "Remove list identifiers from Subject headers."
1100 nil t)
1104 "Translate TAB characters into SPACE characters."
1108 "Eudora has a broken References line, but an OK In-Reply-To."
1122 ;;; Utility functions
1125 "Fancy splitting method.
1126 See the documentation for the variable `nnmail-split-fancy' for documentation."
1135 ;; Alist of split expressions their equivalent regexps.
1138 ;; Return a list of groups matching SPLIT.
1141 ;; nil split
1143 nil)
1145 ;; A group name. Do the \& and \N subs into the string.
1151 ;; Junk the message.
1157 ;; Builtin & operation.
1161 ;; Builtin | operation.
1167 done))
1169 ;; Builtin : operation.
1173 ;; Builtin ! operation.
1177 ;; Check the cache for the regexp for this split.
1190 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\). So,
1191 ;; start-of-value is the point just before the
1192 ;; beginning of the value, whereas after-header-name is
1193 ;; the point just after the field name.
1196 ;; Start the next search just before the beginning of the
1197 ;; VALUE match.
1199 ;; Handle - RESTRICTs
1201 ;; RESTRICT must start after-header-name and
1202 ;; end after start-of-value, so that, for
1203 ;; (any "foo" - "x-foo" "foo.list")
1204 ;; we do not exclude foo.list just because
1205 ;; the header is: ``To: x-foo, foo''
1208 after-header-name t)
1217 ;; Someone might want to do a \N sub on this match, so get the
1218 ;; correct match positions.
1223 split-result))
1225 ;; Not in cache, compute a regexp for the field/value pair.
1229 partial regexp)
1239 field)
1243 value
1246 ;; Now that it's in the cache, just call nnmail-split-it again
1247 ;; on the same split, which will find it immediately in the cache.
1253 c expanded beg N did-expand)
1262 ;; We hit a \; expand it.
1269 ;; \ followed by some character we don't expand.
1271 ;; \& or \N
1277 expanded))))
1281 newtext)))
1283 ;; Activate a backend only if it isn't already activated.
1284 ;; If FORCE, re-read the active file even if the backend is
1285 ;; already activated.
1290 force
1293 backend)))))
1300 backend)))
1310 file-time))
1312 t))
1317 ;;;
1318 ;;; nnmail duplicate handling
1319 ;;;
1339 nnmail-treat-duplicates
1344 ;; Weed out the excess number of Message-IDs.
1350 ;; Save the buffer.
1353 t))
1360 ;; Compiler directives.
1366 ;; Store some information about the group this message is written
1367 ;; to. This function might have been called from various places.
1368 ;; Sometimes, a function up in the calling sequence has an
1369 ;; argument GROUP which is bound to a string, the group name. At
1370 ;; other times, there is a function up in the calling sequence
1371 ;; which has an argument GROUP-ART which is a list of pairs, and
1372 ;; the car of a pair is a group name. Should we check that the
1373 ;; length of the list is equal to 1? -- kai
1404 res))
1406 ;; Fetch the group name corresponding to the message id stored in the
1407 ;; cache.
1421 ;; Function for nnmail-split-fancy: look up all references in the
1422 ;; cache and if a match is found, return that group.
1436 references)
1437 res)))
1454 ;; If this is a duplicate message, then we do not save it.
1460 nnmail-treat-duplicates)
1464 nnmail-treat-duplicates))))
1465 group-art)
1466 ;; We insert a line that says what the mail source is.
1473 ;; Let the backend save the article (or not).
1482 ;; We insert a warning.
1494 ;; Add the group-art list to the history list.
1499 ;;; Get new mail.
1510 "Read new incoming mail."
1514 fetching-sources
1519 incoming incomings source)
1521 sources)
1523 ;; Be compatible with old values.
1536 nil))
1537 ;; Hack to only fetch the contents of a single group's spool file.
1540 group)
1544 :predicate
1550 file)))))))
1557 ;; We first activate all the groups.
1559 ;; Allow the user to hook.
1561 ;; Open the message-id cache.
1563 ;; The we go through all the existing mail source specification
1564 ;; and fetch the mail from each.
1570 source
1574 ',spool-func
1576 nil
1581 ;; If we did indeed read any incoming spools, we save all info.
1592 total))
1593 ;; Close the message-id cache.
1595 ;; Allow the user to hook.
1599 "Say whether an article that is TIME old in GROUP should be expired."
1601 t
1604 nnmail-expiry-wait)))
1607 inhibit))
1608 ;; This isn't an expirable group.
1609 nil)
1611 ;; We expire all articles on sight.
1612 t)
1614 ;; This is an ange-ftp group, and we don't have any dates.
1615 nil)
1618 ;; Compare the time with the current time.
1628 "Check (and modify) the syntax of the message in the current buffer."
1636 "Do a `write-region', and then set the file modes."
1642 ;;;
1643 ;;; Status functions
1644 ;;;
1647 "Make status NAME and VALUE part of the current status line."
1659 "Return a status-value alist from STATUS."
1664 ;; Narrow to the status.
1670 ;; Go through all elements and add them to the list.
1675 ;; Implied "yes".
1680 ;; Implied "no".
1682 ;; Unquoted value.
1685 ;; Quoted value.
1688 status)))
1691 "Return a status string from STATUS."
1702 "Generate an overview of where the last mail split put articles."
1710 elem)
1714 elem
1719 "Remove all instances of GROUP from `nnmail-split-history'."
1728 "Say whether GROUP has new mail."
1730 found)
1734 his nil)))
1735 found))
1738 "Check to see if point is within the headers of a unix mail message.
1739 Doesn't change point."
1749 ;;; arch-tag: fe8f671a-50db-428a-bb5d-f00462f72ed7
1750 ;;; nnmail.el ends here