| blob | 422d5ed5262cdb086f1553507cee56b42acf37f2 |
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, 2009, 2010, 2011 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 of the License, or
14 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
28 ;; For Emacs < 22.2.
46 "Reading mail with Gnus."
50 "Retrieving new mail."
54 "Preparing (or mangling) new mail after retrieval."
58 "Handling of duplicate mail messages."
62 "Organizing the incoming mail in folders."
66 "Mail files."
71 "Expiring old mail."
75 "Interfacing with procmail and other mail agents."
79 "Various mail options."
83 "*Incoming mail will be split according to this variable.
85 If you'd like, for instance, one mail group for mail from the
87 else, you could do something like this:
89 (setq nnmail-split-methods
94 As you can see, this variable is a list of lists, where the first
98 nnmail will try to match on the header to find a fit.
100 The second element can also be a function. In that case, it will be
101 called narrowed to the headers with the first element of the rule as
102 the argument. It should return a non-nil value if it thinks that the
103 mail belongs in that group.
107 This variable can also have a function as its value."
114 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
116 "If non-nil, do crossposting if several split methods match the mail.
117 If nil, the first match found will be used."
122 "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'.
123 This can also be a list of regexps."
131 "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert').
132 This can also be a list of regexps."
139 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
141 "If non-nil, nnmail will never delete/move a group's last article.
142 It can be marked expirable, so it will be deleted when it is no longer last.
144 You may need to set this variable if other programs are putting
145 new mail into folder numbers that Gnus has marked as expired."
151 "If non-nil the mail backends will use long file and directory names.
158 "Set the mode bits of all new mail files to this integer."
163 "*Expirable articles that are older than this will be expired.
164 This variable can either be a number (which will be interpreted as a
165 number of days) -- this doesn't have to be an integer. This variable
166 can also be `immediate' and `never'."
173 "Variable that holds function to specify how old articles should be before they are expired.
174 The function will be called with the name of the group that the expiry
175 is to be performed in, and it should return an integer that says how
177 It can also return the values `never' and `immediate'.
179 Eg.:
181 \(setq nnmail-expiry-wait-function
182 (lambda (newsgroup)
186 (t 7))))"
192 "*Variable that says where expired messages should end up.
193 The default value is `delete' (which says to delete the messages),
194 but it can also be a string or a function. If it is a string, expired
195 messages end up in that group. If it is a function, the function is
196 called in a buffer narrowed to the message in question. The function
197 receives one argument, the name of the group the message comes from.
198 The return value should be `delete' or a group name (a string)."
202 function
203 string))
206 "Determine expiry target based on articles using fancy techniques.
209 `nnmail-expiry-target' is set to the function
210 `nnmail-fancy-expiry-target' and HEADER of the article matches REGEXP,
211 the message will be expired to a group determined by invoking
212 `format-time-string' with TARGET used as the format string and the
213 time extracted from the articles' Date header (if missing the current
214 time is used).
216 In the special cases that HEADER is the symbol `to-from', the regexp
217 will try to match against both the From and the To header.
219 Example:
221 \(setq nnmail-fancy-expiry-targets
236 regexp
240 "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache.
241 If non-nil, also update the cache when copy or move articles."
247 ;; revision 5.29 / p0-85 / Gnus 5.9
248 ;; Variable removed in No Gnus v0.7
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 ()
297 ;; The incoming mail box file.
298 (expand-file-name (user-login-name)
299 rmail-spool-directory))))
301 If you have xwatch running, this will alert it that mail has been
302 read.
304 If you use `display-time', you could use something like this:
306 \(add-hook 'nnmail-read-incoming-hook
307 (lambda ()
308 ;; Update the displayed time, since that will clear out
309 ;; the flag that says you have mail.
316 "Hook called before treating incoming mail.
317 The hook is run in a buffer with all the new, incoming mail."
322 "Hook called narrowed to the headers of each message.
323 This can be used to remove excessive spaces (and stuff like
324 that) from the headers before splitting and saving the messages."
329 "Hook called narrowed to each message."
334 "Regexp that matches list identifiers to be removed.
335 This can also be a list of regexps."
342 "Hook called just before starting to handle new incoming mail."
347 "Hook called just after finishing handling new incoming mail."
352 "Hook called before deciding where to split an article.
353 The functions in this hook are free to modify the buffer
354 contents in any way they choose -- the buffer contents are
355 discarded after running the split process."
360 "*A hook called when a new article is spooled."
366 "*The number of articles which indicates a large newsgroup or nil.
367 If the number of articles is greater than the value, verbose
368 messages will be shown to indicate the current status."
374 "Base widget for recursive datastructures.
376 This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
401 "Widget for customizing splits in the variable of the same name."
415 function
417 )
421 function
425 regexp symbol)
427 regexp
433 regexp))
434 nnmail-split-fancy)
438 "Incoming mail can be split according to this fancy variable.
439 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
441 The format of this variable is SPLIT, where SPLIT can be one of
442 the following:
444 GROUP: Mail will be stored in GROUP (a string).
446 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
447 field FIELD (a regexp) contains VALUE (a regexp), store the messages
448 as specified by SPLIT. If RESTRICT (a regexp) matches some string
449 after FIELD and before the end of the matched VALUE, return nil,
450 otherwise process SPLIT. Multiple RESTRICTs add up, further
451 restricting the possibility of processing SPLIT.
453 \(| SPLIT...): Process each SPLIT expression until one of them matches.
454 A SPLIT expression is said to match if it will cause the mail
455 message to be stored in one or more groups.
457 \(& SPLIT...): Process each SPLIT expression.
459 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
460 the buffer containing the message headers. The return value FUNCTION
461 should be a split, which is then recursively processed.
463 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
464 return value FUNCTION should be a split, which is then recursively
465 processed.
467 junk: Mail will be deleted. Use with care! Do not submerge in water!
468 Example:
469 (setq nnmail-split-fancy
471 ...other.rules.omitted...))
473 FIELD must match a complete field name. VALUE must match a complete
474 word according to the `nnmail-split-fancy-syntax-table' syntax table.
477 FIELD and VALUE can also be Lisp symbols, in that case they are expanded
478 as specified in `nnmail-split-abbrev-alist'.
483 Example:
485 \(setq nnmail-split-methods 'nnmail-split-fancy
486 nnmail-split-fancy
487 ;; Messages from the mailer daemon are not crossposted to any of
488 ;; the ordinary groups. Warnings are put in a separate group
489 ;; from real errors.
492 ;; Non-error messages are crossposted to all relevant
493 ;; groups, but we don't crosspost between the group for the
494 ;; (ding) list and the group for other (ding) related mail.
497 ;; Other mailing lists...
500 ;; Both lists below have the same suffix, so prevent
501 ;; cross-posting to mkpkg.list of messages posted only to
502 ;; the bugs- list, but allow cross-posting when the
503 ;; message was really cross-posted.
506 ;;
507 ;; People...
509 ;; Unmatched mail goes to the catch all group.
521 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
526 "*The approximate number of Message-IDs nnmail will keep in its cache.
527 If this variable is nil, no checking on duplicate messages will be
528 performed."
535 "The file name of the nnmail Message-ID cache."
541 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
542 Three values are valid: nil, which means that nnmail is not to keep a
543 Message-ID cache; `warn', which means that nnmail should insert extra
544 headers to warn the user about the duplication (this is the default);
545 and `delete', which means that nnmail will delete duplicated mails.
547 This variable can also be a function. It will be called from a buffer
548 narrowed to the article in question with the Message-ID as a
549 parameter. It should return nil, `warn' or `delete'."
556 "*Extra headers to parse."
562 "Header lines longer than this limit are excluded from the split function."
568 "Default charset to be used when splitting incoming mail."
574 "Whether the nnmail splitting functionality should MIME decode headers."
580 "Whether to match partial words when fancy splitting.
581 Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
583 surrounded
584 by anything."
591 This avoids the creation of multiple groups when users send to an address
592 using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
597 ;;; Internal variables.
607 ;; support the %-hack
609 table)
618 \f
627 mm-text-coding-system
631 ;; This causes Emacs 22.2 and 22.3 to issue a useless warning.
632 ;;(if (and (featurep 'xemacs) (featurep 'file-coding))
635 ;; Work around a bug in many XEmacs 21.5 betas.
636 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/68134
641 "Insert FILE in server buffer safely."
651 t)
655 "Make file name for GROUP."
660 ?. ?_))
662 ;; If this directory exists, we use it directly.
667 ;; If not, we translate dots into slashes.
670 dir))))
674 "Returns an assoc of group names and active ranges.
675 nn*-request-list should have been called before calling this function."
676 ;; Go through all groups from the active list.
682 "Parse the active file in the current buffer and return an alist."
690 group-assoc group max min)
701 group-assoc)))
705 group-assoc))
711 "Save GROUP-ASSOC in ACTIVE-FILE."
719 "Generate an active file from group-alist ALIST."
730 "Find out whether this FILE is to be split into GROUP only.
731 If SOURCE is a directory spec, try to return the group name component."
737 nil)))
738 nil))
743 start message-id content-length do-search end)
753 ;; Skip all the headers in case there are more "From "s...
758 ;; Unquote the ">From " line, if any.
764 ;; Find the Message-ID header.
770 ;; There is no Message-ID here, so we create one.
778 ;; Look for a Content-Length header.
786 ;; We destroy the header, since none of
787 ;; the backends ever use it, and we do not
788 ;; want to confuse other mailers by having
789 ;; a (possibly) faulty header.
802 ;; Go to the beginning of the next article - or to the end
803 ;; of the buffer.
817 count))
820 "Put point at the beginning of the next Unix mbox message."
821 ;; Algorithm used to find the next article in the
822 ;; brain-dead Unix mbox format:
823 ;;
824 ;; 1) Search for "^From ".
825 ;; 2) If we find it, then see whether the previous
826 ;; line is blank and the next line looks like a header.
827 ;; Then it's possible that this is a mail delim, and we use it.
829 found)
849 "Put point at the beginning of the current Unix mbox message."
850 ;; Algorithm used to find the next article in the
851 ;; brain-dead Unix mbox format:
852 ;;
853 ;; 1) Search for "^From ".
854 ;; 2) If we find it, then see whether the previous
855 ;; line is blank and the next line looks like a header.
856 ;; Then it's possible that this is a mail delim, and we use it.
858 found)
880 start message-id content-length end skip head-end)
884 ;; Possibly wrong format?
888 ;; Carry on until the bitter end.
891 end nil)
892 ;; Find the end of the head.
894 start
897 ;; This will never happen, but just to be on the safe side --
898 ;; if there is no head-body delimiter, we search a bit manually.
903 ;; Find the Message-ID header.
911 ;; There is no Message-ID here, so we create one.
914 ;; Look for a Content-Length header.
920 ;; We destroy the header, since none of the backends ever
921 ;; use it, and we do not want to confuse other mailers by
922 ;; having a (possibly) faulty header.
926 ;; Find the end of this article.
930 ;; We try the Content-Length value. The idea: skip over the header
931 ;; separator, then check what happens content-length bytes into the
932 ;; message body. This should be either the end of the buffer, the
933 ;; message separator or a blank line followed by the separator.
934 ;; The blank line should probably be deleted. If neither of the
935 ;; three is met, the content-length header is probably invalid.
950 ;; No Content-Length, so we find the beginning of the next
951 ;; article or the end of the buffer.
955 ;; Allow the backend to save the article.
964 count))
970 start message-id end)
974 ;; Possibly wrong format?
976 ;; Carry on until the bitter end.
979 ;; Find the end of the head.
981 start
984 ;; This will never happen, but just to be on the safe side --
985 ;; if there is no head-body delimiter, we search a bit manually.
990 ;; Find the Message-ID header.
994 ;; There is no Message-ID here, so we create one.
1002 ;; Find the end of this article.
1008 ;; Allow the backend to save the article.
1018 count))
1021 ;; In a maildir, every file contains exactly one mail.
1023 message-id)
1025 ;; Find the end of the head.
1030 ;; This will never happen, but just to be on the safe side --
1031 ;; if there is no head-body delimiter, we search a bit manually.
1036 ;; Find the Message-ID header.
1040 ;; There is no Message-ID here, so we create one.
1048 ;; Allow the backend to save the article.
1059 group artnum-func)
1060 "Go through the entire INCOMING file and pick out each individual mail.
1061 FUNC will be called with the buffer narrowed to each mail."
1063 ;; methods to just this group.
1067 nnmail-split-methods))
1070 ;; Insert the incoming file.
1077 0
1080 ;; Handle both babyl, MMDF and unix mail formats, since
1081 ;; movemail will use the former when fetching from a
1082 ;; mailbox, the latter when fetching from a file.
1097 "Look at the headers and return an alist of groups that match.
1098 FUNC will be called with the group name to determine the article number."
1101 group-art method grp)
1104 ;; If there is only just one group to put everything in, we
1105 ;; just return a list with just this one method in.
1108 ;; We do actual comparison.
1110 ;; Copy the article into the work buffer.
1114 ;; Narrow to headers.
1121 ;; Decode MIME headers and charsets.
1125 ;; Fold continuation lines.
1129 ;; Nuke pathologically long headers. Since Gnus applies
1130 ;; pathologically complex regexps to the buffer, lines
1131 ;; that are looong will take longer than the Universe's
1132 ;; existence to process.
1136 nnmail-split-header-length-limit)
1139 ;; Allow washing.
1148 ;; `nnmail-split-methods' is a function, so we
1149 ;; just call this function here and use the
1150 ;; result.
1159 ;; The article may be "cross-posted" to `junk'. What
1160 ;; to do? Just remove the `junk' spec. Don't really
1161 ;; see anything else to do...
1169 split))))
1170 ;; Go through the split methods to find a match.
1184 nil t)))
1187 pos)
1188 ;; Function to say whether this is a match.
1190 ;; Don't enter the article into the same
1191 ;; group twice.
1194 group-art))
1195 ;; This is the final group, which is used as a
1196 ;; catch-all.
1201 ;; Fall back on "bogus" if all else fails.
1204 ;; Produce a trace if non-empty.
1216 ;; See whether the split methods returned `junk'.
1218 nil
1219 ;; The article may be "cross-posted" to `junk'. What
1220 ;; to do? Just remove the `junk' spec. Don't really
1221 ;; see anything else to do...
1228 "Insert how many lines there are in the body of the mail.
1229 Return the number of characters in the body."
1244 chars)))
1247 "Insert an Xref line based on the (group . article) alist."
1267 ;;; Message washing functions
1270 "Remove excessive whitespace from all headers."
1276 "Remove list identifiers from Subject headers."
1280 nnmail-list-identifiers)))
1285 nil t)
1289 nil t)
1294 "Translate TAB characters into SPACE characters."
1299 "Header line matching mailer producing bogus References lines.
1300 See `nnmail-ignore-broken-references'."
1306 "Ignore the References line and use In-Reply-To
1308 Eudora has a broken References line, but an OK In-Reply-To."
1325 ;;; Utility functions
1331 "Utility function to directly post a message to an nnmail-derived group.
1332 Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1333 to actually put the message in the right group."
1342 to-newsgroup))
1344 to-newsgroup gnus-command-method)
1346 gnus-command-method))
1353 "Fancy splitting method.
1354 See the documentation for the variable `nnmail-split-fancy' for details."
1359 ;; Alist of split expressions their equivalent regexps.
1362 ;; Return a list of groups matching SPLIT.
1365 ;; nil split
1367 nil)
1369 ;; A group name. Do the \& and \N subs into the string.
1375 ;; Junk the message.
1381 ;; Builtin & operation.
1385 ;; Builtin | operation.
1391 done))
1393 ;; Builtin : operation.
1399 ;; Builtin ! operation.
1403 ;; Check the cache for the regexp for this split.
1416 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1417 ;; So, start-of-value is the point just before the
1418 ;; beginning of the value, whereas after-header-name
1419 ;; is the point just after the field name.
1422 ;; Start the next search just before the beginning of the
1423 ;; VALUE match.
1425 ;; Handle - RESTRICTs
1427 ;; RESTRICT must start after-header-name and
1428 ;; end after start-of-value, so that, for
1429 ;; (any "foo" - "x-foo" "foo.list")
1430 ;; we do not exclude foo.list just because
1431 ;; the header is: ``To: x-foo, foo''
1434 after-header-name t)
1443 ;; Someone might want to do a \N sub on this match, so get the
1444 ;; correct match positions.
1449 split-result))
1451 ;; Not in cache, compute a regexp for the field/value pair.
1456 partial-front
1457 partial-rear
1458 regexp)
1465 ;; Same trick for the rear of the regexp
1470 ;; Invert the match-partial-words behavior if the optional
1471 ;; last element is specified.
1476 nnmail-split-fancy-match-partial-words)
1482 field)
1486 value
1490 ;; Now that it's in the cache, just call nnmail-split-it again
1491 ;; on the same split, which will find it immediately in the cache.
1497 c expanded beg N did-expand)
1506 ;; We hit a \; expand it.
1513 ;; \ followed by some character we don't expand.
1515 ;; \& or \N
1524 expanded))))
1528 newtext)))
1530 ;; Activate a backend only if it isn't already activated.
1531 ;; If FORCE, re-read the active file even if the backend is
1532 ;; already activated.
1537 force
1540 backend)))))
1547 backend)))
1557 file-time))
1559 t))
1564 ;;;
1565 ;;; nnmail duplicate handling
1566 ;;;
1587 nnmail-treat-duplicates
1592 ;; Weed out the excess number of Message-IDs.
1598 ;; Save the buffer.
1601 t))
1608 ;; Compiler directives.
1614 ;; this will handle cases like `B r' where the group is nil
1617 id grp subject sender))
1619 ;; Store some information about the group this message is written
1620 ;; to. This is passed in as the grp argument -- all locations this
1621 ;; has been called from have been checked and the group is available.
1622 ;; The only ambiguous case is nnmail-check-duplication which will only
1623 ;; pass the first (of possibly >1) group which matches. -Josh
1635 nnmail-cache-ignore-groups)))
1654 res))
1656 ;; Fetch the group name corresponding to the message id stored in the
1657 ;; cache.
1670 ;; Function for nnmail-split-fancy: look up all references in the
1671 ;; cache and if a match is found, return that group.
1673 "Split this message into the same group as its parent.
1674 This function can be used as an entry in `nnmail-split-fancy', for
1675 example like this: (: nnmail-split-fancy-with-parent)
1676 For a message to be split, it looks for the parent message in the
1677 References or In-Reply-To header and then looks in the message id
1678 cache file (given by the variable `nnmail-message-id-cache-file') to
1679 see which group that message was put in. This group is returned.
1681 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1689 nnmail-split-fancy-with-parent-ignore-groups
1691 nnmail-split-fancy-with-parent-ignore-groups)))
1701 res)))
1718 ;; If this is a duplicate message, then we do not save it.
1724 nnmail-treat-duplicates)
1728 nnmail-treat-duplicates))))
1729 group-art)
1730 ;; We insert a line that says what the mail source is.
1737 ;; Let the backend save the article (or not).
1746 ;; We insert a warning.
1758 ;; Add the group-art list to the history list.
1763 ;;; Get new mail.
1774 "Read new incoming mail."
1778 group in-group spool-func)
1780 fetching-sources
1784 incoming incomings source)
1786 sources)
1788 ;; Use group's parameter
1796 group group spool-func))
1798 ;; Hack to only fetch the contents of a single group's spool file.
1801 group)
1805 :predicate
1817 ;; We first activate all the groups.
1819 ;; Allow the user to hook.
1821 ;; Open the message-id cache.
1823 ;; The we go through all the existing mail source specification
1824 ;; and fetch the mail from each.
1830 source
1835 ',spool-func
1838 nil
1843 ;; If we did indeed read any incoming spools, we save all info.
1854 total))
1855 ;; Close the message-id cache.
1857 ;; Allow the user to hook.
1861 "Say whether an article that is TIME old in GROUP should be expired."
1863 t
1866 nnmail-expiry-wait)))
1869 inhibit))
1870 ;; This isn't an expirable group.
1871 nil)
1873 ;; We expire all articles on sight.
1874 t)
1876 ;; This is an ange-ftp group, and we don't have any dates.
1877 nil)
1880 ;; Compare the time with the current time.
1886 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1887 ;; that buffer if the nnfolder group isn't selected.
1889 ;; Don't enter Message-IDs into cache.
1890 ;; Let users hack it in TARGET function.
1901 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1918 ;; If the header is to-from then match against the
1919 ;; To or From header
1936 "Check (and modify) the syntax of the message in the current buffer."
1944 "Do a `write-region', and then set the file modes."
1950 ;;;
1951 ;;; Status functions
1952 ;;;
1955 "Make status NAME and VALUE part of the current status line."
1967 "Return a status-value alist from STATUS."
1972 ;; Narrow to the status.
1978 ;; Go through all elements and add them to the list.
1983 ;; Implied "yes".
1988 ;; Implied "no".
1990 ;; Unquoted value.
1993 ;; Quoted value.
1996 status)))
1999 "Return a status string from STATUS."
2010 "Generate an overview of where the last mail split put articles."
2020 elem
2025 "Remove all instances of GROUP from `nnmail-split-history'."
2034 "Say whether GROUP has new mail."
2036 found)
2040 his nil)))
2041 found))
2044 "Check to see if point is within the headers of a unix mail message.
2045 Doesn't change point."
2055 ;; arch-tag: fe8f671a-50db-428a-bb5d-f00462f72ed7
2056 ;;; nnmail.el ends here