| blob | 3228055eddf13a89e9da549dd01ccfe527bf616c |
1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;;; Code:
30 ;; For Emacs < 22.2.
49 "Reading mail with Gnus."
53 "Retrieving new mail."
57 "Preparing (or mangling) new mail after retrieval."
61 "Handling of duplicate mail messages."
65 "Organizing the incoming mail in folders."
69 "Mail files."
74 "Expiring old mail."
78 "Interfacing with procmail and other mail agents."
82 "Various mail options."
86 "*Incoming mail will be split according to this variable.
88 If you'd like, for instance, one mail group for mail from the
90 else, you could do something like this:
92 (setq nnmail-split-methods
97 As you can see, this variable is a list of lists, where the first
101 nnmail will try to match on the header to find a fit.
103 The second element can also be a function. In that case, it will be
104 called narrowed to the headers with the first element of the rule as
105 the argument. It should return a non-nil value if it thinks that the
106 mail belongs in that group.
110 This variable can also have a function as its value."
117 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
119 "If non-nil, do crossposting if several split methods match the mail.
120 If nil, the first match found will be used."
125 "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'.
126 This can also be a list of regexps."
134 "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert').
135 This can also be a list of regexps."
142 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
144 "If non-nil, nnmail will never delete/move a group's last article.
145 It can be marked expirable, so it will be deleted when it is no longer last.
147 You may need to set this variable if other programs are putting
148 new mail into folder numbers that Gnus has marked as expired."
154 "If non-nil the mail backends will use long file and directory names.
161 "Set the mode bits of all new mail files to this integer."
166 "*Expirable articles that are older than this will be expired.
167 This variable can either be a number (which will be interpreted as a
168 number of days) -- this doesn't have to be an integer. This variable
169 can also be `immediate' and `never'."
176 "Variable that holds function to specify how old articles should be before they are expired.
177 The function will be called with the name of the group that the expiry
178 is to be performed in, and it should return an integer that says how
180 It can also return the values `never' and `immediate'.
182 Eg.:
184 \(setq nnmail-expiry-wait-function
185 (lambda (newsgroup)
189 (t 7))))"
195 "*Variable that says where expired messages should end up.
196 The default value is `delete' (which says to delete the messages),
197 but it can also be a string or a function. If it is a string, expired
198 messages end up in that group. If it is a function, the function is
199 called in a buffer narrowed to the message in question. The function
200 receives one argument, the name of the group the message comes from.
201 The return value should be `delete' or a group name (a string)."
206 string))
209 "Determine expiry target based on articles using fancy techniques.
212 `nnmail-expiry-target' is set to the function
213 `nnmail-fancy-expiry-target' and HEADER of the article matches REGEXP,
214 the message will be expired to a group determined by invoking
215 `format-time-string' with TARGET used as the format string and the
216 time extracted from the articles' Date header (if missing the current
217 time is used).
219 In the special cases that HEADER is the symbol `to-from', the regexp
220 will try to match against both the From and the To header.
222 Example:
224 \(setq nnmail-fancy-expiry-targets
239 regexp
243 "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache.
244 If non-nil, also update the cache when copy or move articles."
249 "This option is obsolete in Gnus 5.9. \
251 ;; revision 5.29 / p0-85 / Gnus 5.9
252 ;; Variable removed in No Gnus v0.7
255 "*If non-nil, re-split incoming procmail sorted mail."
260 "*If non-nil, scan all incoming procmail sorted mails once.
261 It scans low-level sorted spools even when not required."
267 "Function called to delete files in some mail backends."
273 'copy-file
275 "*Function called to create a copy of a file.
276 This is `add-name-to-file' by default, which means that crossposts
277 will use hard links. If your file system doesn't allow hard
278 links, you could set this variable to `copy-file' instead."
287 nil)
288 "*Hook that will be run after the incoming mail has been transferred.
289 The incoming mail is moved from the specified spool file (which normally is
291 directory. This hook is called after the incoming mail box has been
292 emptied, and can be used to call any mail box programs you have
295 Eg.
297 \(add-hook 'nnmail-read-incoming-hook
298 (lambda ()
301 ;; The incoming mail box file.
302 (expand-file-name (user-login-name)
303 rmail-spool-directory))))
305 If you have xwatch running, this will alert it that mail has been
306 read.
308 If you use `display-time', you could use something like this:
310 \(add-hook 'nnmail-read-incoming-hook
311 (lambda ()
312 ;; Update the displayed time, since that will clear out
313 ;; the flag that says you have mail.
320 "Hook called before treating incoming mail.
321 The hook is run in a buffer with all the new, incoming mail."
326 "Hook called narrowed to the headers of each message.
327 This can be used to remove excessive spaces (and stuff like
328 that) from the headers before splitting and saving the messages."
333 "Hook called narrowed to each message."
338 "Regexp that matches list identifiers to be removed.
339 This can also be a list of regexps."
346 "Hook called just before starting to handle new incoming mail."
351 "Hook called just after finishing handling new incoming mail."
356 "Hook called before deciding where to split an article.
357 The functions in this hook are free to modify the buffer
358 contents in any way they choose -- the buffer contents are
359 discarded after running the split process."
364 "*A hook called when a new article is spooled."
370 "*The number of articles which indicates a large newsgroup or nil.
371 If the number of articles is greater than the value, verbose
372 messages will be shown to indicate the current status."
378 "Base widget for recursive datastructures.
380 This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
405 "Widget for customizing splits in the variable of the same name."
419 function
421 )
425 function
429 regexp symbol)
431 regexp
437 regexp))
438 nnmail-split-fancy)
442 "Incoming mail can be split according to this fancy variable.
443 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
445 The format of this variable is SPLIT, where SPLIT can be one of
446 the following:
448 GROUP: Mail will be stored in GROUP (a string).
450 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
451 field FIELD (a regexp) contains VALUE (a regexp), store the messages
452 as specified by SPLIT. If RESTRICT (a regexp) matches some string
453 after FIELD and before the end of the matched VALUE, return nil,
454 otherwise process SPLIT. Multiple RESTRICTs add up, further
455 restricting the possibility of processing SPLIT.
457 \(| SPLIT...): Process each SPLIT expression until one of them matches.
458 A SPLIT expression is said to match if it will cause the mail
459 message to be stored in one or more groups.
461 \(& SPLIT...): Process each SPLIT expression.
463 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
464 the buffer containing the message headers. The return value FUNCTION
465 should be a split, which is then recursively processed.
467 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
468 return value FUNCTION should be a split, which is then recursively
469 processed.
471 junk: Mail will be deleted. Use with care! Do not submerge in water!
472 Example:
473 (setq nnmail-split-fancy
475 ...other.rules.omitted...))
477 FIELD must match a complete field name. VALUE must match a complete
478 word according to the `nnmail-split-fancy-syntax-table' syntax table.
481 FIELD and VALUE can also be Lisp symbols, in that case they are expanded
482 as specified in `nnmail-split-abbrev-alist'.
487 Example:
489 \(setq nnmail-split-methods 'nnmail-split-fancy
490 nnmail-split-fancy
491 ;; Messages from the mailer daemon are not crossposted to any of
492 ;; the ordinary groups. Warnings are put in a separate group
493 ;; from real errors.
496 ;; Non-error messages are crossposted to all relevant
497 ;; groups, but we don't crosspost between the group for the
498 ;; (ding) list and the group for other (ding) related mail.
501 ;; Other mailing lists...
504 ;; Both lists below have the same suffix, so prevent
505 ;; cross-posting to mkpkg.list of messages posted only to
506 ;; the bugs- list, but allow cross-posting when the
507 ;; message was really cross-posted.
510 ;;
511 ;; People...
513 ;; Unmatched mail goes to the catch all group.
525 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
530 "*The approximate number of Message-IDs nnmail will keep in its cache.
531 If this variable is nil, no checking on duplicate messages will be
532 performed."
539 "The file name of the nnmail Message-ID cache."
545 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
546 Three values are valid: nil, which means that nnmail is not to keep a
547 Message-ID cache; `warn', which means that nnmail should insert extra
548 headers to warn the user about the duplication (this is the default);
549 and `delete', which means that nnmail will delete duplicated mails.
551 This variable can also be a function. It will be called from a buffer
552 narrowed to the article in question with the Message-ID as a
553 parameter. It should return nil, `warn' or `delete'."
560 "*Extra headers to parse."
566 "Header lines longer than this limit are excluded from the split function."
572 "Default charset to be used when splitting incoming mail."
578 "Whether the nnmail splitting functionality should MIME decode headers."
584 "Whether to match partial words when fancy splitting.
585 Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
587 surrounded
588 by anything."
595 This avoids the creation of multiple groups when users send to an address
596 using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
601 ;;; Internal variables.
611 ;; support the %-hack
613 table)
622 \f
631 mm-text-coding-system
638 "Insert FILE in server buffer safely."
648 t)
652 "Make file name for GROUP."
657 ?. ?_))
659 ;; If this directory exists, we use it directly.
664 ;; If not, we translate dots into slashes.
667 dir))))
671 "Returns an assoc of group names and active ranges.
672 nn*-request-list should have been called before calling this function."
673 ;; Go through all groups from the active list.
679 "Parse the active file in the current buffer and return an alist."
687 group-assoc group max min)
698 group-assoc)))
702 group-assoc))
708 "Save GROUP-ASSOC in ACTIVE-FILE."
716 "Generate an active file from group-alist ALIST."
727 "Find out whether this FILE is to be split into GROUP only.
728 If SOURCE is a directory spec, try to return the group name component."
734 nil)))
735 nil))
740 start message-id content-length do-search end)
750 ;; Skip all the headers in case there are more "From "s...
755 ;; Unquote the ">From " line, if any.
761 ;; Find the Message-ID header.
767 ;; There is no Message-ID here, so we create one.
775 ;; Look for a Content-Length header.
783 ;; We destroy the header, since none of
784 ;; the backends ever use it, and we do not
785 ;; want to confuse other mailers by having
786 ;; a (possibly) faulty header.
799 ;; Go to the beginning of the next article - or to the end
800 ;; of the buffer.
814 count))
817 "Put point at the beginning of the next Unix mbox message."
818 ;; Algorithm used to find the next article in the
819 ;; brain-dead Unix mbox format:
820 ;;
821 ;; 1) Search for "^From ".
822 ;; 2) If we find it, then see whether the previous
823 ;; line is blank and the next line looks like a header.
824 ;; Then it's possible that this is a mail delim, and we use it.
826 found)
846 "Put point at the beginning of the current Unix mbox message."
847 ;; Algorithm used to find the next article in the
848 ;; brain-dead Unix mbox format:
849 ;;
850 ;; 1) Search for "^From ".
851 ;; 2) If we find it, then see whether the previous
852 ;; line is blank and the next line looks like a header.
853 ;; Then it's possible that this is a mail delim, and we use it.
855 found)
877 start message-id content-length end skip head-end)
881 ;; Possibly wrong format?
885 ;; Carry on until the bitter end.
888 end nil)
889 ;; Find the end of the head.
891 start
894 ;; This will never happen, but just to be on the safe side --
895 ;; if there is no head-body delimiter, we search a bit manually.
900 ;; Find the Message-ID header.
908 ;; There is no Message-ID here, so we create one.
911 ;; Look for a Content-Length header.
917 ;; We destroy the header, since none of the backends ever
918 ;; use it, and we do not want to confuse other mailers by
919 ;; having a (possibly) faulty header.
923 ;; Find the end of this article.
927 ;; We try the Content-Length value. The idea: skip over the header
928 ;; separator, then check what happens content-length bytes into the
929 ;; message body. This should be either the end of the buffer, the
930 ;; message separator or a blank line followed by the separator.
931 ;; The blank line should probably be deleted. If neither of the
932 ;; three is met, the content-length header is probably invalid.
947 ;; No Content-Length, so we find the beginning of the next
948 ;; article or the end of the buffer.
952 ;; Allow the backend to save the article.
961 count))
967 start message-id end)
971 ;; Possibly wrong format?
973 ;; Carry on until the bitter end.
976 ;; Find the end of the head.
978 start
981 ;; This will never happen, but just to be on the safe side --
982 ;; if there is no head-body delimiter, we search a bit manually.
987 ;; Find the Message-ID header.
991 ;; There is no Message-ID here, so we create one.
999 ;; Find the end of this article.
1005 ;; Allow the backend to save the article.
1015 count))
1018 ;; In a maildir, every file contains exactly one mail.
1020 message-id)
1022 ;; Find the end of the head.
1027 ;; This will never happen, but just to be on the safe side --
1028 ;; if there is no head-body delimiter, we search a bit manually.
1033 ;; Find the Message-ID header.
1037 ;; There is no Message-ID here, so we create one.
1045 ;; Allow the backend to save the article.
1056 group artnum-func)
1057 "Go through the entire INCOMING file and pick out each individual mail.
1058 FUNC will be called with the buffer narrowed to each mail."
1060 ;; methods to just this group.
1064 nnmail-split-methods))
1067 ;; Insert the incoming file.
1074 0
1077 ;; Handle both babyl, MMDF and unix mail formats, since
1078 ;; movemail will use the former when fetching from a
1079 ;; mailbox, the latter when fetching from a file.
1094 "Look at the headers and return an alist of groups that match.
1095 FUNC will be called with the group name to determine the article number."
1098 group-art method grp)
1101 ;; If there is only just one group to put everything in, we
1102 ;; just return a list with just this one method in.
1105 ;; We do actual comparison.
1107 ;; Copy the article into the work buffer.
1111 ;; Narrow to headers.
1118 ;; Decode MIME headers and charsets.
1122 ;; Fold continuation lines.
1126 ;; Nuke pathologically long headers. Since Gnus applies
1127 ;; pathologically complex regexps to the buffer, lines
1128 ;; that are looong will take longer than the Universe's
1129 ;; existence to process.
1133 nnmail-split-header-length-limit)
1136 ;; Allow washing.
1145 ;; `nnmail-split-methods' is a function, so we
1146 ;; just call this function here and use the
1147 ;; result.
1156 ;; The article may be "cross-posted" to `junk'. What
1157 ;; to do? Just remove the `junk' spec. Don't really
1158 ;; see anything else to do...
1166 split))))
1167 ;; Go through the split methods to find a match.
1181 nil t)))
1184 pos)
1185 ;; Function to say whether this is a match.
1187 ;; Don't enter the article into the same
1188 ;; group twice.
1191 group-art))
1192 ;; This is the final group, which is used as a
1193 ;; catch-all.
1198 ;; Fall back on "bogus" if all else fails.
1201 ;; Produce a trace if non-empty.
1213 ;; See whether the split methods returned `junk'.
1215 nil
1216 ;; The article may be "cross-posted" to `junk'. What
1217 ;; to do? Just remove the `junk' spec. Don't really
1218 ;; see anything else to do...
1225 "Insert how many lines there are in the body of the mail.
1226 Return the number of characters in the body."
1241 chars)))
1244 "Insert an Xref line based on the (group . article) alist."
1264 ;;; Message washing functions
1267 "Remove excessive whitespace from all headers."
1273 "Remove list identifiers from Subject headers."
1277 nnmail-list-identifiers)))
1282 nil t)
1286 nil t)
1291 "Translate TAB characters into SPACE characters."
1296 "Header line matching mailer producing bogus References lines.
1297 See `nnmail-ignore-broken-references'."
1303 "Ignore the References line and use In-Reply-To
1305 Eudora has a broken References line, but an OK In-Reply-To."
1322 ;;; Utility functions
1328 "Utility function to directly post a message to an nnmail-derived group.
1329 Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1330 to actually put the message in the right group."
1339 to-newsgroup))
1341 to-newsgroup gnus-command-method)
1343 gnus-command-method))
1350 "Fancy splitting method.
1351 See the documentation for the variable `nnmail-split-fancy' for details."
1356 ;; Alist of split expressions their equivalent regexps.
1359 ;; Return a list of groups matching SPLIT.
1362 ;; nil split
1364 nil)
1366 ;; A group name. Do the \& and \N subs into the string.
1372 ;; Junk the message.
1378 ;; Builtin & operation.
1382 ;; Builtin | operation.
1388 done))
1390 ;; Builtin : operation.
1396 ;; Builtin ! operation.
1400 ;; Check the cache for the regexp for this split.
1413 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1414 ;; So, start-of-value is the point just before the
1415 ;; beginning of the value, whereas after-header-name
1416 ;; is the point just after the field name.
1419 ;; Start the next search just before the beginning of the
1420 ;; VALUE match.
1422 ;; Handle - RESTRICTs
1424 ;; RESTRICT must start after-header-name and
1425 ;; end after start-of-value, so that, for
1426 ;; (any "foo" - "x-foo" "foo.list")
1427 ;; we do not exclude foo.list just because
1428 ;; the header is: ``To: x-foo, foo''
1431 after-header-name t)
1440 ;; Someone might want to do a \N sub on this match, so get the
1441 ;; correct match positions.
1446 split-result))
1448 ;; Not in cache, compute a regexp for the field/value pair.
1453 partial-front
1454 partial-rear
1455 regexp)
1462 ;; Same trick for the rear of the regexp
1467 ;; Invert the match-partial-words behavior if the optional
1468 ;; last element is specified.
1473 nnmail-split-fancy-match-partial-words)
1479 field)
1483 value
1487 ;; Now that it's in the cache, just call nnmail-split-it again
1488 ;; on the same split, which will find it immediately in the cache.
1494 c expanded beg N did-expand)
1503 ;; We hit a \; expand it.
1510 ;; \ followed by some character we don't expand.
1512 ;; \& or \N
1521 expanded))))
1525 newtext)))
1527 ;; Activate a backend only if it isn't already activated.
1528 ;; If FORCE, re-read the active file even if the backend is
1529 ;; already activated.
1534 force
1537 backend)))))
1544 backend)))
1554 file-time))
1556 t))
1561 ;;;
1562 ;;; nnmail duplicate handling
1563 ;;;
1584 nnmail-treat-duplicates
1589 ;; Weed out the excess number of Message-IDs.
1595 ;; Save the buffer.
1598 t))
1605 ;; Compiler directives.
1611 ;; this will handle cases like `B r' where the group is nil
1614 id grp subject sender))
1616 ;; Store some information about the group this message is written
1617 ;; to. This is passed in as the grp argument -- all locations this
1618 ;; has been called from have been checked and the group is available.
1619 ;; The only ambiguous case is nnmail-check-duplication which will only
1620 ;; pass the first (of possibly >1) group which matches. -Josh
1632 nnmail-cache-ignore-groups)))
1651 res))
1653 ;; Fetch the group name corresponding to the message id stored in the
1654 ;; cache.
1667 ;; Function for nnmail-split-fancy: look up all references in the
1668 ;; cache and if a match is found, return that group.
1670 "Split this message into the same group as its parent.
1671 This function can be used as an entry in `nnmail-split-fancy', for
1672 example like this: (: nnmail-split-fancy-with-parent)
1673 For a message to be split, it looks for the parent message in the
1674 References or In-Reply-To header and then looks in the message id
1675 cache file (given by the variable `nnmail-message-id-cache-file') to
1676 see which group that message was put in. This group is returned.
1678 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1686 nnmail-split-fancy-with-parent-ignore-groups
1688 nnmail-split-fancy-with-parent-ignore-groups)))
1698 res)))
1715 ;; If this is a duplicate message, then we do not save it.
1721 nnmail-treat-duplicates)
1725 nnmail-treat-duplicates))))
1726 group-art)
1727 ;; We insert a line that says what the mail source is.
1734 ;; Let the backend save the article (or not).
1743 ;; We insert a warning.
1755 ;; Add the group-art list to the history list.
1760 ;;; Get new mail.
1771 "Read new incoming mail."
1775 group in-group spool-func)
1777 fetching-sources
1781 incoming incomings source)
1783 sources)
1785 ;; Use group's parameter
1793 group group spool-func))
1795 ;; Hack to only fetch the contents of a single group's spool file.
1798 group)
1802 :predicate
1814 ;; We first activate all the groups.
1816 ;; Allow the user to hook.
1818 ;; Open the message-id cache.
1820 ;; The we go through all the existing mail source specification
1821 ;; and fetch the mail from each.
1827 source
1832 ',spool-func
1835 nil
1840 ;; If we did indeed read any incoming spools, we save all info.
1851 total))
1852 ;; Close the message-id cache.
1854 ;; Allow the user to hook.
1858 "Say whether an article that is TIME old in GROUP should be expired."
1860 t
1863 nnmail-expiry-wait)))
1866 inhibit))
1867 ;; This isn't an expirable group.
1868 nil)
1870 ;; We expire all articles on sight.
1871 t)
1873 ;; This is an ange-ftp group, and we don't have any dates.
1874 nil)
1877 ;; Compare the time with the current time.
1883 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1884 ;; that buffer if the nnfolder group isn't selected.
1886 ;; Don't enter Message-IDs into cache.
1887 ;; Let users hack it in TARGET function.
1898 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1915 ;; If the header is to-from then match against the
1916 ;; To or From header
1933 "Check (and modify) the syntax of the message in the current buffer."
1941 "Do a `write-region', and then set the file modes."
1947 ;;;
1948 ;;; Status functions
1949 ;;;
1952 "Make status NAME and VALUE part of the current status line."
1964 "Return a status-value alist from STATUS."
1969 ;; Narrow to the status.
1975 ;; Go through all elements and add them to the list.
1980 ;; Implied "yes".
1985 ;; Implied "no".
1987 ;; Unquoted value.
1990 ;; Quoted value.
1993 status)))
1996 "Return a status string from STATUS."
2007 "Generate an overview of where the last mail split put articles."
2017 elem
2022 "Remove all instances of GROUP from `nnmail-split-history'."
2031 "Say whether GROUP has new mail."
2033 found)
2037 his nil)))
2038 found))
2041 "Check to see if point is within the headers of a unix mail message.
2042 Doesn't change point."
2052 ;; arch-tag: fe8f671a-50db-428a-bb5d-f00462f72ed7
2053 ;;; nnmail.el ends here