| blob | e05c286b1abbd05553a0119082b8d9e6750c8d29 |
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 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:
44 "Reading mail with Gnus."
48 "Retrieving new mail."
52 "Preparing (or mangling) new mail after retrieval."
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 "This option is obsolete in Gnus 5.9. \
246 ;; revision 5.29 / p0-85 / Gnus 5.9
247 ;; Variable removed in No Gnus v0.7
250 "*If non-nil, re-split incoming procmail sorted mail."
255 "*If non-nil, scan all incoming procmail sorted mails once.
256 It scans low-level sorted spools even when not required."
262 "Function called to delete files in some mail backends."
268 'copy-file
270 "*Function called to create a copy of a file.
271 This is `add-name-to-file' by default, which means that crossposts
272 will use hard links. If your file system doesn't allow hard
273 links, you could set this variable to `copy-file' instead."
282 nil)
283 "*Hook that will be run after the incoming mail has been transferred.
284 The incoming mail is moved from the specified spool file (which normally is
286 directory. This hook is called after the incoming mail box has been
287 emptied, and can be used to call any mail box programs you have
290 Eg.
292 \(add-hook 'nnmail-read-incoming-hook
293 (lambda ()
296 ;; The incoming mail box file.
297 (expand-file-name (user-login-name)
298 rmail-spool-directory))))
300 If you have xwatch running, this will alert it that mail has been
301 read.
303 If you use `display-time', you could use something like this:
305 \(add-hook 'nnmail-read-incoming-hook
306 (lambda ()
307 ;; Update the displayed time, since that will clear out
308 ;; the flag that says you have mail.
315 "Hook called before treating incoming mail.
316 The hook is run in a buffer with all the new, incoming mail."
321 "Hook called narrowed to the headers of each message.
322 This can be used to remove excessive spaces (and stuff like
323 that) from the headers before splitting and saving the messages."
328 "Hook called narrowed to each message."
333 "Regexp that matches list identifiers to be removed.
334 This can also be a list of regexps."
341 "Hook called just before starting to handle new incoming mail."
346 "Hook called just after finishing handling new incoming mail."
351 "Hook called before deciding where to split an article.
352 The functions in this hook are free to modify the buffer
353 contents in any way they choose -- the buffer contents are
354 discarded after running the split process."
359 "*A hook called when a new article is spooled."
365 "*The number of articles which indicates a large newsgroup or nil.
366 If the number of articles is greater than the value, verbose
367 messages will be shown to indicate the current status."
373 "Base widget for recursive datastructures.
375 This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
400 "Widget for customizing splits in the variable of the same name."
414 function
416 )
420 function
424 regexp symbol)
426 regexp
432 regexp))
433 nnmail-split-fancy)
437 "Incoming mail can be split according to this fancy variable.
438 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
440 The format of this variable is SPLIT, where SPLIT can be one of
441 the following:
443 GROUP: Mail will be stored in GROUP (a string).
445 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
446 field FIELD (a regexp) contains VALUE (a regexp), store the messages
447 as specified by SPLIT. If RESTRICT (a regexp) matches some string
448 after FIELD and before the end of the matched VALUE, return nil,
449 otherwise process SPLIT. Multiple RESTRICTs add up, further
450 restricting the possibility of processing SPLIT.
452 \(| SPLIT...): Process each SPLIT expression until one of them matches.
453 A SPLIT expression is said to match if it will cause the mail
454 message to be stored in one or more groups.
456 \(& SPLIT...): Process each SPLIT expression.
458 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
459 the buffer containing the message headers. The return value FUNCTION
460 should be a split, which is then recursively processed.
462 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
463 return value FUNCTION should be a split, which is then recursively
464 processed.
466 junk: Mail will be deleted. Use with care! Do not submerge in water!
467 Example:
468 (setq nnmail-split-fancy
470 ...other.rules.omitted...))
472 FIELD must match a complete field name. VALUE must match a complete
473 word according to the `nnmail-split-fancy-syntax-table' syntax table.
476 FIELD and VALUE can also be Lisp symbols, in that case they are expanded
477 as specified in `nnmail-split-abbrev-alist'.
482 Example:
484 \(setq nnmail-split-methods 'nnmail-split-fancy
485 nnmail-split-fancy
486 ;; Messages from the mailer daemon are not crossposted to any of
487 ;; the ordinary groups. Warnings are put in a separate group
488 ;; from real errors.
491 ;; Non-error messages are crossposted to all relevant
492 ;; groups, but we don't crosspost between the group for the
493 ;; (ding) list and the group for other (ding) related mail.
496 ;; Other mailing lists...
499 ;; Both lists below have the same suffix, so prevent
500 ;; cross-posting to mkpkg.list of messages posted only to
501 ;; the bugs- list, but allow cross-posting when the
502 ;; message was really cross-posted.
505 ;;
506 ;; People...
508 ;; Unmatched mail goes to the catch all group.
520 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
525 "*The approximate number of Message-IDs nnmail will keep in its cache.
526 If this variable is nil, no checking on duplicate messages will be
527 performed."
533 "*The file name of the nnmail Message-ID cache."
539 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
540 Three values are valid: nil, which means that nnmail is not to keep a
541 Message-ID cache; `warn', which means that nnmail should insert extra
542 headers to warn the user about the duplication (this is the default);
543 and `delete', which means that nnmail will delete duplicated mails.
545 This variable can also be a function. It will be called from a buffer
546 narrowed to the article in question with the Message-ID as a
547 parameter. It should return nil, `warn' or `delete'."
554 "*Extra headers to parse."
560 "Header lines longer than this limit are excluded from the split function."
566 "Default charset to be used when splitting incoming mail."
572 "Whether the nnmail splitting functionality should MIME decode headers."
578 "Whether to match partial words when fancy splitting.
579 Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
581 surrounded
582 by anything."
589 This avoids the creation of multiple groups when users send to an address
590 using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
595 ;;; Internal variables.
605 ;; support the %-hack
607 table)
616 \f
625 mm-text-coding-system
632 "Insert FILE in server buffer safely."
642 t)
646 "Make file name for GROUP."
651 ?. ?_))
653 ;; If this directory exists, we use it directly.
658 ;; If not, we translate dots into slashes.
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."
710 "Generate an active file from group-alist ALIST."
721 "Find out whether this FILE is to be split into GROUP only.
722 If SOURCE is a directory spec, try to return the group name component."
728 nil)))
729 nil))
734 start message-id content-length do-search end)
744 ;; Skip all the headers in case there are more "From "s...
749 ;; Unquote the ">From " line, if any.
755 ;; Find the Message-ID header.
761 ;; There is no Message-ID here, so we create one.
769 ;; Look for a Content-Length header.
777 ;; We destroy the header, since none of
778 ;; the backends ever use it, and we do not
779 ;; want to confuse other mailers by having
780 ;; a (possibly) faulty header.
793 ;; Go to the beginning of the next article - or to the end
794 ;; of the buffer.
808 count))
811 "Put point at the beginning of the next Unix mbox message."
812 ;; Algorithm used to find the next article in the
813 ;; brain-dead Unix mbox format:
814 ;;
815 ;; 1) Search for "^From ".
816 ;; 2) If we find it, then see whether the previous
817 ;; line is blank and the next line looks like a header.
818 ;; Then it's possible that this is a mail delim, and we use it.
820 found)
840 "Put point at the beginning of the current Unix mbox message."
841 ;; Algorithm used to find the next article in the
842 ;; brain-dead Unix mbox format:
843 ;;
844 ;; 1) Search for "^From ".
845 ;; 2) If we find it, then see whether the previous
846 ;; line is blank and the next line looks like a header.
847 ;; Then it's possible that this is a mail delim, and we use it.
849 found)
871 start message-id content-length end skip head-end)
875 ;; Possibly wrong format?
879 ;; Carry on until the bitter end.
882 end nil)
883 ;; Find the end of the head.
885 start
888 ;; This will never happen, but just to be on the safe side --
889 ;; if there is no head-body delimiter, we search a bit manually.
894 ;; Find the Message-ID header.
902 ;; There is no Message-ID here, so we create one.
905 ;; Look for a Content-Length header.
911 ;; We destroy the header, since none of the backends ever
912 ;; use it, and we do not want to confuse other mailers by
913 ;; having a (possibly) faulty header.
917 ;; Find the end of this article.
921 ;; We try the Content-Length value. The idea: skip over the header
922 ;; separator, then check what happens content-length bytes into the
923 ;; message body. This should be either the end of the buffer, the
924 ;; message separator or a blank line followed by the separator.
925 ;; The blank line should probably be deleted. If neither of the
926 ;; three is met, the content-length header is probably invalid.
941 ;; No Content-Length, so we find the beginning of the next
942 ;; article or the end of the buffer.
946 ;; Allow the backend to save the article.
955 count))
961 start message-id end)
965 ;; Possibly wrong format?
967 ;; Carry on until the bitter end.
970 ;; Find the end of the head.
972 start
975 ;; This will never happen, but just to be on the safe side --
976 ;; if there is no head-body delimiter, we search a bit manually.
981 ;; Find the Message-ID header.
985 ;; There is no Message-ID here, so we create one.
993 ;; Find the end of this article.
999 ;; Allow the backend to save the article.
1009 count))
1012 ;; In a maildir, every file contains exactly one mail.
1014 message-id)
1016 ;; Find the end of the head.
1021 ;; This will never happen, but just to be on the safe side --
1022 ;; if there is no head-body delimiter, we search a bit manually.
1027 ;; Find the Message-ID header.
1031 ;; There is no Message-ID here, so we create one.
1039 ;; Allow the backend to save the article.
1050 group artnum-func)
1051 "Go through the entire INCOMING file and pick out each individual mail.
1052 FUNC will be called with the buffer narrowed to each mail."
1054 ;; methods to just this group.
1058 nnmail-split-methods))
1061 ;; Insert the incoming file.
1068 0
1071 ;; Handle both babyl, MMDF and unix mail formats, since
1072 ;; movemail will use the former when fetching from a
1073 ;; mailbox, the latter when fetching from a file.
1088 "Look at the headers and return an alist of groups that match.
1089 FUNC will be called with the group name to determine the article number."
1092 group-art method grp)
1095 ;; If there is only just one group to put everything in, we
1096 ;; just return a list with just this one method in.
1099 ;; We do actual comparison.
1101 ;; Copy the article into the work buffer.
1105 ;; Narrow to headers.
1112 ;; Decode MIME headers and charsets.
1116 ;; Fold continuation lines.
1120 ;; Nuke pathologically long headers. Since Gnus applies
1121 ;; pathologically complex regexps to the buffer, lines
1122 ;; that are looong will take longer than the Universe's
1123 ;; existence to process.
1127 nnmail-split-header-length-limit)
1130 ;; Allow washing.
1139 ;; `nnmail-split-methods' is a function, so we
1140 ;; just call this function here and use the
1141 ;; result.
1150 ;; The article may be "cross-posted" to `junk'. What
1151 ;; to do? Just remove the `junk' spec. Don't really
1152 ;; see anything else to do...
1160 split))))
1161 ;; Go through the split methods to find a match.
1175 nil t)))
1178 pos)
1179 ;; Function to say whether this is a match.
1181 ;; Don't enter the article into the same
1182 ;; group twice.
1185 group-art))
1186 ;; This is the final group, which is used as a
1187 ;; catch-all.
1192 ;; Fall back on "bogus" if all else fails.
1195 ;; Produce a trace if non-empty.
1207 ;; See whether the split methods returned `junk'.
1209 nil
1210 ;; The article may be "cross-posted" to `junk'. What
1211 ;; to do? Just remove the `junk' spec. Don't really
1212 ;; see anything else to do...
1219 "Insert how many lines there are in the body of the mail.
1220 Return the number of characters in the body."
1235 chars)))
1238 "Insert an Xref line based on the (group . article) alist."
1258 ;;; Message washing functions
1261 "Remove excessive whitespace from all headers."
1267 "Remove list identifiers from Subject headers."
1271 nnmail-list-identifiers)))
1276 nil t)
1280 nil t)
1285 "Translate TAB characters into SPACE characters."
1290 "Header line matching mailer producing bogus References lines.
1291 See `nnmail-ignore-broken-references'."
1297 "Ignore the References line and use In-Reply-To
1299 Eudora has a broken References line, but an OK In-Reply-To."
1316 ;;; Utility functions
1319 "Utility function to directly post a message to an nnmail-derived group.
1320 Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1321 to actually put the message in the right group."
1330 to-newsgroup))
1332 to-newsgroup gnus-command-method)
1334 gnus-command-method))
1341 "Fancy splitting method.
1342 See the documentation for the variable `nnmail-split-fancy' for details."
1347 ;; Alist of split expressions their equivalent regexps.
1350 ;; Return a list of groups matching SPLIT.
1353 ;; nil split
1355 nil)
1357 ;; A group name. Do the \& and \N subs into the string.
1363 ;; Junk the message.
1369 ;; Builtin & operation.
1373 ;; Builtin | operation.
1379 done))
1381 ;; Builtin : operation.
1387 ;; Builtin ! operation.
1391 ;; Check the cache for the regexp for this split.
1404 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1405 ;; So, start-of-value is the point just before the
1406 ;; beginning of the value, whereas after-header-name
1407 ;; is the point just after the field name.
1410 ;; Start the next search just before the beginning of the
1411 ;; VALUE match.
1413 ;; Handle - RESTRICTs
1415 ;; RESTRICT must start after-header-name and
1416 ;; end after start-of-value, so that, for
1417 ;; (any "foo" - "x-foo" "foo.list")
1418 ;; we do not exclude foo.list just because
1419 ;; the header is: ``To: x-foo, foo''
1422 after-header-name t)
1431 ;; Someone might want to do a \N sub on this match, so get the
1432 ;; correct match positions.
1437 split-result))
1439 ;; Not in cache, compute a regexp for the field/value pair.
1444 partial-front
1445 partial-rear
1446 regexp)
1453 ;; Same trick for the rear of the regexp
1458 ;; Invert the match-partial-words behavior if the optional
1459 ;; last element is specified.
1464 nnmail-split-fancy-match-partial-words)
1470 field)
1474 value
1478 ;; Now that it's in the cache, just call nnmail-split-it again
1479 ;; on the same split, which will find it immediately in the cache.
1485 c expanded beg N did-expand)
1494 ;; We hit a \; expand it.
1501 ;; \ followed by some character we don't expand.
1503 ;; \& or \N
1512 expanded))))
1516 newtext)))
1518 ;; Activate a backend only if it isn't already activated.
1519 ;; If FORCE, re-read the active file even if the backend is
1520 ;; already activated.
1525 force
1528 backend)))))
1535 backend)))
1545 file-time))
1547 t))
1552 ;;;
1553 ;;; nnmail duplicate handling
1554 ;;;
1575 nnmail-treat-duplicates
1580 ;; Weed out the excess number of Message-IDs.
1586 ;; Save the buffer.
1589 t))
1596 ;; Compiler directives.
1602 ;; this will handle cases like `B r' where the group is nil
1605 id grp subject sender))
1607 ;; Store some information about the group this message is written
1608 ;; to. This is passed in as the grp argument -- all locations this
1609 ;; has been called from have been checked and the group is available.
1610 ;; The only ambiguous case is nnmail-check-duplication which will only
1611 ;; pass the first (of possibly >1) group which matches. -Josh
1623 nnmail-cache-ignore-groups)))
1642 res))
1644 ;; Fetch the group name corresponding to the message id stored in the
1645 ;; cache.
1658 ;; Function for nnmail-split-fancy: look up all references in the
1659 ;; cache and if a match is found, return that group.
1661 "Split this message into the same group as its parent.
1662 This function can be used as an entry in `nnmail-split-fancy', for
1663 example like this: (: nnmail-split-fancy-with-parent)
1664 For a message to be split, it looks for the parent message in the
1665 References or In-Reply-To header and then looks in the message id
1666 cache file (given by the variable `nnmail-message-id-cache-file') to
1667 see which group that message was put in. This group is returned.
1669 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1677 nnmail-split-fancy-with-parent-ignore-groups
1679 nnmail-split-fancy-with-parent-ignore-groups)))
1689 res)))
1706 ;; If this is a duplicate message, then we do not save it.
1712 nnmail-treat-duplicates)
1716 nnmail-treat-duplicates))))
1717 group-art)
1718 ;; We insert a line that says what the mail source is.
1725 ;; Let the backend save the article (or not).
1734 ;; We insert a warning.
1746 ;; Add the group-art list to the history list.
1751 ;;; Get new mail.
1762 "Read new incoming mail."
1764 fetching-sources
1769 incoming incomings source)
1771 sources)
1773 ;; Hack to only fetch the contents of a single group's spool file.
1776 group)
1780 :predicate
1792 ;; We first activate all the groups.
1794 ;; Allow the user to hook.
1796 ;; Open the message-id cache.
1798 ;; The we go through all the existing mail source specification
1799 ;; and fetch the mail from each.
1805 source
1810 ',spool-func
1812 nil
1817 ;; If we did indeed read any incoming spools, we save all info.
1828 total))
1829 ;; Close the message-id cache.
1831 ;; Allow the user to hook.
1835 "Say whether an article that is TIME old in GROUP should be expired."
1837 t
1840 nnmail-expiry-wait)))
1843 inhibit))
1844 ;; This isn't an expirable group.
1845 nil)
1847 ;; We expire all articles on sight.
1848 t)
1850 ;; This is an ange-ftp group, and we don't have any dates.
1851 nil)
1854 ;; Compare the time with the current time.
1858 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1859 ;; that buffer if the nnfolder group isn't selected.
1861 ;; Don't enter Message-IDs into cache.
1862 ;; Let users hack it in TARGET function.
1873 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1890 ;; If the header is to-from then match against the
1891 ;; To or From header
1908 "Check (and modify) the syntax of the message in the current buffer."
1916 "Do a `write-region', and then set the file modes."
1922 ;;;
1923 ;;; Status functions
1924 ;;;
1927 "Make status NAME and VALUE part of the current status line."
1939 "Return a status-value alist from STATUS."
1944 ;; Narrow to the status.
1950 ;; Go through all elements and add them to the list.
1955 ;; Implied "yes".
1960 ;; Implied "no".
1962 ;; Unquoted value.
1965 ;; Quoted value.
1968 status)))
1971 "Return a status string from STATUS."
1982 "Generate an overview of where the last mail split put articles."
1992 elem
1997 "Remove all instances of GROUP from `nnmail-split-history'."
2006 "Say whether GROUP has new mail."
2008 found)
2012 his nil)))
2013 found))
2016 "Check to see if point is within the headers of a unix mail message.
2017 Doesn't change point."
2027 ;;; arch-tag: fe8f671a-50db-428a-bb5d-f00462f72ed7
2028 ;;; nnmail.el ends here