| blob | c0689335f67d8a8af4a0277220ca5300866f0806 |
1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
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:
44 "Reading mail with Gnus."
48 "Retrieving new mail."
52 "Preparing (or mangling) new mail after retrival."
56 "Handling of duplicate mail messages."
60 "Organizing the incoming mail in folders."
64 "Mail files."
69 "Expiring old mail."
73 "Interfacing with procmail and other mail agents."
77 "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."
112 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
114 "If non-nil, do crossposting if several split methods match the mail.
115 If nil, the first match found will be used."
120 "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'.
121 This can also be a list of regexps."
129 "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert').
130 This can also be a list of regexps."
137 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
139 "If non-nil, nnmail will never delete/move a group's last article.
140 It can be marked expirable, so it will be deleted when it is no longer last.
142 You may need to set this variable if other programs are putting
143 new mail into folder numbers that Gnus has marked as expired."
149 "If non-nil the mail backends will use long file and directory names.
156 "Set the mode bits of all new mail files to this integer."
161 "*Expirable articles that are older than this will be expired.
162 This variable can either be a number (which will be interpreted as a
163 number of days) -- this doesn't have to be an integer. This variable
164 can also be `immediate' and `never'."
171 "Variable that holds function to specify how old articles should be before they are expired.
172 The function will be called with the name of the group that the expiry
173 is to be performed in, and it should return an integer that says how
175 It can also return the values `never' and `immediate'.
177 Eg.:
179 \(setq nnmail-expiry-wait-function
180 (lambda (newsgroup)
184 (t 7))))"
190 "*Variable that says where expired messages should end up.
191 The default value is `delete' (which says to delete the messages),
192 but it can also be a string or a function. If it is a string, expired
193 messages end up in that group. If it is a function, the function is
194 called in a buffer narrowed to the message in question. The function
195 receives one argument, the name of the group the message comes from.
196 The return value should be `delete' or a group name (a string)."
201 string))
204 "Determine expiry target based on articles using fancy techniques.
207 `nnmail-expiry-target' is set to the function
208 `nnmail-fancy-expiry-target' and HEADER of the article matches REGEXP,
209 the message will be expired to a group determined by invoking
210 `format-time-string' with TARGET used as the format string and the
211 time extracted from the articles' Date header (if missing the current
212 time is used).
214 In the special cases that HEADER is the symbol `to-from', the regexp
215 will try to match against both the From and the To header.
217 Example:
219 \(setq nnmail-fancy-expiry-targets
234 regexp
238 "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache.
239 If non-nil, also update the cache when copy or move articles."
244 "*Where the mail backends will look for incoming mail.
245 This variable is a list of mail source specifiers.
246 This variable is obsolete; `mail-sources' should be used instead."
251 "*If non-nil, re-split incoming procmail sorted mail."
256 "*If non-nil, scan all incoming procmail sorted mails once.
257 It scans low-level sorted spools even when not required."
263 "Function called to delete files in some mail backends."
269 'copy-file
271 "*Function called to create a copy of a file.
272 This is `add-name-to-file' by default, which means that crossposts
273 will use hard links. If your file system doesn't allow hard
274 links, you could set this variable to `copy-file' instead."
283 nil)
284 "*Hook that will be run after the incoming mail has been transferred.
285 The incoming mail is moved from the specified spool file (which normally is
287 directory. This hook is called after the incoming mail box has been
288 emptied, and can be used to call any mail box programs you have
291 Eg.
293 \(add-hook 'nnmail-read-incoming-hook
294 (lambda ()
298 If you have xwatch running, this will alert it that mail has been
299 read.
301 If you use `display-time', you could use something like this:
303 \(add-hook 'nnmail-read-incoming-hook
304 (lambda ()
305 ;; Update the displayed time, since that will clear out
306 ;; the flag that says you have mail.
313 "Hook called before treating incoming mail.
314 The hook is run in a buffer with all the new, incoming mail."
319 "Hook called narrowed to the headers of each message.
320 This can be used to remove excessive spaces (and stuff like
321 that) from the headers before splitting and saving the messages."
326 "Hook called narrowed to each message."
331 "Regexp that matches list identifiers to be removed.
332 This can also be a list of regexps."
339 "Hook called just before starting to handle new incoming mail."
344 "Hook called just after finishing handling new incoming mail."
349 "Hook called before deciding where to split an article.
350 The functions in this hook are free to modify the buffer
351 contents in any way they choose -- the buffer contents are
352 discarded after running the split process."
357 "*A hook called when a new article is spooled."
363 "*The number of articles which indicates a large newsgroup or nil.
364 If the number of articles is greater than the value, verbose
365 messages will be shown to indicate the current status."
371 "Base widget for recursive datastructures.
373 This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
398 "Widget for customizing splits in the variable of the same name."
412 function
414 )
418 function
422 regexp symbol)
424 regexp
430 regexp))
431 nnmail-split-fancy)
435 "Incoming mail can be split according to this fancy variable.
436 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
438 The format of this variable is SPLIT, where SPLIT can be one of
439 the following:
441 GROUP: Mail will be stored in GROUP (a string).
443 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
444 field FIELD (a regexp) contains VALUE (a regexp), store the messages
445 as specified by SPLIT. If RESTRICT (a regexp) matches some string
446 after FIELD and before the end of the matched VALUE, return nil,
447 otherwise process SPLIT. Multiple RESTRICTs add up, further
448 restricting the possibility of processing SPLIT.
450 \(| SPLIT...): Process each SPLIT expression until one of them matches.
451 A SPLIT expression is said to match if it will cause the mail
452 message to be stored in one or more groups.
454 \(& SPLIT...): Process each SPLIT expression.
456 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
457 the buffer containing the message headers. The return value FUNCTION
458 should be a split, which is then recursively processed.
460 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
461 return value FUNCTION should be a split, which is then recursively
462 processed.
464 junk: Mail will be deleted. Use with care! Do not submerge in water!
465 Example:
466 (setq nnmail-split-fancy
468 ...other.rules.omitted...))
470 FIELD must match a complete field name. VALUE must match a complete
471 word according to the `nnmail-split-fancy-syntax-table' syntax table.
474 FIELD and VALUE can also be lisp symbols, in that case they are expanded
475 as specified in `nnmail-split-abbrev-alist'.
480 Example:
482 \(setq nnmail-split-methods 'nnmail-split-fancy
483 nnmail-split-fancy
484 ;; Messages from the mailer daemon are not crossposted to any of
485 ;; the ordinary groups. Warnings are put in a separate group
486 ;; from real errors.
489 ;; Non-error messages are crossposted to all relevant
490 ;; groups, but we don't crosspost between the group for the
491 ;; (ding) list and the group for other (ding) related mail.
494 ;; Other mailing lists...
497 ;; Both lists below have the same suffix, so prevent
498 ;; cross-posting to mkpkg.list of messages posted only to
499 ;; the bugs- list, but allow cross-posting when the
500 ;; message was really cross-posted.
503 ;;
504 ;; People...
506 ;; Unmatched mail goes to the catch all group.
518 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
523 "*The approximate number of Message-IDs nnmail will keep in its cache.
524 If this variable is nil, no checking on duplicate messages will be
525 performed."
531 "*The file name of the nnmail Message-ID cache."
537 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
538 Three values are valid: nil, which means that nnmail is not to keep a
539 Message-ID cache; `warn', which means that nnmail should insert extra
540 headers to warn the user about the duplication (this is the default);
541 and `delete', which means that nnmail will delete duplicated mails.
543 This variable can also be a function. It will be called from a buffer
544 narrowed to the article in question with the Message-ID as a
545 parameter. It should return nil, `warn' or `delete'."
552 "*Extra headers to parse."
558 "Header lines longer than this limit are excluded from the split function."
564 "Default charset to be used when splitting incoming mail."
570 "Whether the nnmail splitting functionality should MIME decode headers."
576 "Whether to match partial words when fancy splitting.
577 Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
579 surrounded
580 by anything."
587 This avoids the creation of multiple groups when users send to an address
588 using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
593 ;;; Internal variables.
603 ;; support the %-hack
605 table)
614 \f
623 mm-text-coding-system
630 "Insert FILE in server buffer safely."
640 t)
644 "Make file name for GROUP."
649 ?. ?_))
651 ;; If this directory exists, we use it directly.
656 ;; If not, we translate dots into slashes.
660 nnmail-pathname-coding-system)
661 dir))))
665 "Returns an assoc of group names and active ranges.
666 nn*-request-list should have been called before calling this function."
667 ;; Go through all groups from the active list.
673 "Parse the active file in the current buffer and return an alist."
681 group-assoc group max min)
692 group-assoc)))
696 group-assoc))
702 "Save GROUP-ASSOC in ACTIVE-FILE."
709 "Generate an active file from group-alist ALIST."
720 "Find out whether this FILE is to be split into GROUP only.
721 If SOURCE is a directory spec, try to return the group name component."
727 nil)))
728 nil))
733 start message-id content-length do-search end)
743 ;; Skip all the headers in case there are more "From "s...
748 ;; Unquote the ">From " line, if any.
754 ;; Find the Message-ID header.
760 ;; There is no Message-ID here, so we create one.
768 ;; Look for a Content-Length header.
776 ;; We destroy the header, since none of
777 ;; the backends ever use it, and we do not
778 ;; want to confuse other mailers by having
779 ;; a (possibly) faulty header.
792 ;; Go to the beginning of the next article - or to the end
793 ;; of the buffer.
807 count))
810 "Put point at the beginning of the next Unix mbox message."
811 ;; Algorithm used to find the next article in the
812 ;; brain-dead Unix mbox format:
813 ;;
814 ;; 1) Search for "^From ".
815 ;; 2) If we find it, then see whether the previous
816 ;; line is blank and the next line looks like a header.
817 ;; Then it's possible that this is a mail delim, and we use it.
819 found)
839 "Put point at the beginning of the current Unix mbox message."
840 ;; Algorithm used to find the next article in the
841 ;; brain-dead Unix mbox format:
842 ;;
843 ;; 1) Search for "^From ".
844 ;; 2) If we find it, then see whether the previous
845 ;; line is blank and the next line looks like a header.
846 ;; Then it's possible that this is a mail delim, and we use it.
848 found)
870 start message-id content-length end skip head-end)
874 ;; Possibly wrong format?
878 ;; Carry on until the bitter end.
881 end nil)
882 ;; Find the end of the head.
884 start
887 ;; This will never happen, but just to be on the safe side --
888 ;; if there is no head-body delimiter, we search a bit manually.
893 ;; Find the Message-ID header.
901 ;; There is no Message-ID here, so we create one.
904 ;; Look for a Content-Length header.
910 ;; We destroy the header, since none of the backends ever
911 ;; use it, and we do not want to confuse other mailers by
912 ;; having a (possibly) faulty header.
916 ;; Find the end of this article.
920 ;; We try the Content-Length value. The idea: skip over the header
921 ;; separator, then check what happens content-length bytes into the
922 ;; message body. This should be either the end of the buffer, the
923 ;; message separator or a blank line followed by the separator.
924 ;; The blank line should probably be deleted. If neither of the
925 ;; three is met, the content-length header is probably invalid.
940 ;; No Content-Length, so we find the beginning of the next
941 ;; article or the end of the buffer.
945 ;; Allow the backend to save the article.
954 count))
960 start message-id end)
964 ;; Possibly wrong format?
966 ;; Carry on until the bitter end.
969 ;; Find the end of the head.
971 start
974 ;; This will never happen, but just to be on the safe side --
975 ;; if there is no head-body delimiter, we search a bit manually.
980 ;; Find the Message-ID header.
984 ;; There is no Message-ID here, so we create one.
992 ;; Find the end of this article.
998 ;; Allow the backend to save the article.
1008 count))
1011 ;; In a maildir, every file contains exactly one mail.
1013 message-id)
1015 ;; Find the end of the head.
1020 ;; This will never happen, but just to be on the safe side --
1021 ;; if there is no head-body delimiter, we search a bit manually.
1026 ;; Find the Message-ID header.
1030 ;; There is no Message-ID here, so we create one.
1038 ;; Allow the backend to save the article.
1046 group artnum-func)
1047 "Go through the entire INCOMING file and pick out each individual mail.
1048 FUNC will be called with the buffer narrowed to each mail."
1050 ;; methods to just this group.
1054 nnmail-split-methods)))
1056 ;; Insert the incoming file.
1063 0
1066 ;; Handle both babyl, MMDF and unix mail formats, since
1067 ;; movemail will use the former when fetching from a
1068 ;; mailbox, the latter when fetching from a file.
1083 "Look at the headers and return an alist of groups that match.
1084 FUNC will be called with the group name to determine the article number."
1087 group-art method grp)
1090 ;; If there is only just one group to put everything in, we
1091 ;; just return a list with just this one method in.
1094 ;; We do actual comparison.
1096 ;; Copy the article into the work buffer.
1100 ;; Narrow to headers.
1107 ;; Decode MIME headers and charsets.
1111 ;; Fold continuation lines.
1115 ;; Nuke pathologically long headers. Since Gnus applies
1116 ;; pathologically complex regexps to the buffer, lines
1117 ;; that are looong will take longer than the Universe's
1118 ;; existence to process.
1122 nnmail-split-header-length-limit)
1125 ;; Allow washing.
1134 ;; `nnmail-split-methods' is a function, so we
1135 ;; just call this function here and use the
1136 ;; result.
1145 ;; The article may be "cross-posted" to `junk'. What
1146 ;; to do? Just remove the `junk' spec. Don't really
1147 ;; see anything else to do...
1155 split))))
1156 ;; Go through the split methods to find a match.
1170 nil t)))
1173 pos)
1174 ;; Function to say whether this is a match.
1176 ;; Don't enter the article into the same
1177 ;; group twice.
1180 group-art))
1181 ;; This is the final group, which is used as a
1182 ;; catch-all.
1187 ;; Fall back on "bogus" if all else fails.
1190 ;; Produce a trace if non-empty.
1202 ;; See whether the split methods returned `junk'.
1204 nil
1205 ;; The article may be "cross-posted" to `junk'. What
1206 ;; to do? Just remove the `junk' spec. Don't really
1207 ;; see anything else to do...
1214 "Insert how many lines there are in the body of the mail.
1215 Return the number of characters in the body."
1230 chars)))
1233 "Insert an Xref line based on the (group . article) alist."
1248 nnmail-pathname-coding-system)
1253 ;;; Message washing functions
1256 "Remove excessive whitespace from all headers."
1262 "Remove list identifiers from Subject headers."
1266 nnmail-list-identifiers)))
1271 nil t)
1275 nil t)
1280 "Translate TAB characters into SPACE characters."
1284 "Eudora has a broken References line, but an OK In-Reply-To."
1298 ;;; Utility functions
1301 "Utility function to directly post a message to an nnmail-derived group.
1302 Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1303 to actually put the message in the right group."
1312 to-newsgroup))
1314 to-newsgroup gnus-command-method)
1316 gnus-command-method))
1323 "Fancy splitting method.
1324 See the documentation for the variable `nnmail-split-fancy' for details."
1333 ;; Alist of split expressions their equivalent regexps.
1336 ;; Return a list of groups matching SPLIT.
1339 ;; nil split
1341 nil)
1343 ;; A group name. Do the \& and \N subs into the string.
1349 ;; Junk the message.
1355 ;; Builtin & operation.
1359 ;; Builtin | operation.
1365 done))
1367 ;; Builtin : operation.
1373 ;; Builtin ! operation.
1377 ;; Check the cache for the regexp for this split.
1390 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1391 ;; So, start-of-value is the point just before the
1392 ;; beginning of the value, whereas after-header-name
1393 ;; is the point just after the field name.
1396 ;; Start the next search just before the beginning of the
1397 ;; VALUE match.
1399 ;; Handle - RESTRICTs
1401 ;; RESTRICT must start after-header-name and
1402 ;; end after start-of-value, so that, for
1403 ;; (any "foo" - "x-foo" "foo.list")
1404 ;; we do not exclude foo.list just because
1405 ;; the header is: ``To: x-foo, foo''
1408 after-header-name t)
1417 ;; Someone might want to do a \N sub on this match, so get the
1418 ;; correct match positions.
1423 split-result))
1425 ;; Not in cache, compute a regexp for the field/value pair.
1429 partial-front
1430 partial-rear
1431 regexp)
1438 ;; Same trick for the rear of the regexp
1449 field)
1453 value
1457 ;; Now that it's in the cache, just call nnmail-split-it again
1458 ;; on the same split, which will find it immediately in the cache.
1464 c expanded beg N did-expand)
1473 ;; We hit a \; expand it.
1480 ;; \ followed by some character we don't expand.
1482 ;; \& or \N
1491 expanded))))
1495 newtext)))
1497 ;; Activate a backend only if it isn't already activated.
1498 ;; If FORCE, re-read the active file even if the backend is
1499 ;; already activated.
1504 force
1507 backend)))))
1514 backend)))
1524 file-time))
1526 t))
1531 ;;;
1532 ;;; nnmail duplicate handling
1533 ;;;
1554 nnmail-treat-duplicates
1559 ;; Weed out the excess number of Message-IDs.
1565 ;; Save the buffer.
1568 t))
1575 ;; Compiler directives.
1581 ;; this will handle cases like `B r' where the group is nil
1584 id grp subject sender))
1586 ;; Store some information about the group this message is written
1587 ;; to. This is passed in as the grp argument -- all locations this
1588 ;; has been called from have been checked and the group is available.
1589 ;; The only ambiguous case is nnmail-check-duplication which will only
1590 ;; pass the first (of possibly >1) group which matches. -Josh
1602 nnmail-cache-ignore-groups)))
1621 res))
1623 ;; Fetch the group name corresponding to the message id stored in the
1624 ;; cache.
1637 ;; Function for nnmail-split-fancy: look up all references in the
1638 ;; cache and if a match is found, return that group.
1640 "Split this message into the same group as its parent.
1641 This function can be used as an entry in `nnmail-split-fancy', for
1642 example like this: (: nnmail-split-fancy-with-parent)
1643 For a message to be split, it looks for the parent message in the
1644 References or In-Reply-To header and then looks in the message id
1645 cache file (given by the variable `nnmail-message-id-cache-file') to
1646 see which group that message was put in. This group is returned.
1648 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1656 nnmail-split-fancy-with-parent-ignore-groups
1658 nnmail-split-fancy-with-parent-ignore-groups)))
1668 references)
1669 res)))
1686 ;; If this is a duplicate message, then we do not save it.
1692 nnmail-treat-duplicates)
1696 nnmail-treat-duplicates))))
1697 group-art)
1698 ;; We insert a line that says what the mail source is.
1705 ;; Let the backend save the article (or not).
1714 ;; We insert a warning.
1726 ;; Add the group-art list to the history list.
1731 ;;; Get new mail.
1742 "Read new incoming mail."
1746 fetching-sources
1751 incoming incomings source)
1753 sources)
1755 ;; Be compatible with old values.
1768 nil))
1769 ;; Hack to only fetch the contents of a single group's spool file.
1772 group)
1776 :predicate
1788 ;; We first activate all the groups.
1790 ;; Allow the user to hook.
1792 ;; Open the message-id cache.
1794 ;; The we go through all the existing mail source specification
1795 ;; and fetch the mail from each.
1801 source
1806 ',spool-func
1808 nil
1813 ;; If we did indeed read any incoming spools, we save all info.
1824 total))
1825 ;; Close the message-id cache.
1827 ;; Allow the user to hook.
1831 "Say whether an article that is TIME old in GROUP should be expired."
1833 t
1836 nnmail-expiry-wait)))
1839 inhibit))
1840 ;; This isn't an expirable group.
1841 nil)
1843 ;; We expire all articles on sight.
1844 t)
1846 ;; This is an ange-ftp group, and we don't have any dates.
1847 nil)
1850 ;; Compare the time with the current time.
1854 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1855 ;; that buffer if the nnfolder group isn't selected.
1857 ;; Don't enter Message-IDs into cache.
1858 ;; Let users hack it in TARGET function.
1869 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1880 ;; If the header is to-from then match against the
1881 ;; To or From header
1896 "Check (and modify) the syntax of the message in the current buffer."
1904 "Do a `write-region', and then set the file modes."
1910 ;;;
1911 ;;; Status functions
1912 ;;;
1915 "Make status NAME and VALUE part of the current status line."
1927 "Return a status-value alist from STATUS."
1932 ;; Narrow to the status.
1938 ;; Go through all elements and add them to the list.
1943 ;; Implied "yes".
1948 ;; Implied "no".
1950 ;; Unquoted value.
1953 ;; Quoted value.
1956 status)))
1959 "Return a status string from STATUS."
1970 "Generate an overview of where the last mail split put articles."
1978 elem)
1982 elem
1987 "Remove all instances of GROUP from `nnmail-split-history'."
1996 "Say whether GROUP has new mail."
1998 found)
2002 his nil)))
2003 found))
2006 "Check to see if point is within the headers of a unix mail message.
2007 Doesn't change point."
2017 ;;; arch-tag: fe8f671a-50db-428a-bb5d-f00462f72ed7
2018 ;;; nnmail.el ends here