| blob | db5415cf9f71b665b7f9a2d43bc3823a96f6e004 |
1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
3 ;; Copyright (C) 1995-2017 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 3 of the License, or
13 ;; (at your option) 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. If not, see <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
42 "Reading mail with Gnus."
46 "Retrieving new mail."
50 "Preparing (or mangling) new mail after retrieval."
54 "Handling of duplicate mail messages."
58 "Organizing the incoming mail in folders."
62 "Mail files."
67 "Expiring old mail."
71 "Interfacing with procmail and other mail agents."
75 "Various mail options."
79 "Incoming mail will be split according to this variable.
81 If you'd like, for instance, one mail group for mail from the
83 else, you could do something like this:
85 (setq nnmail-split-methods
90 As you can see, this variable is a list of lists, where the first
94 nnmail will try to match on the header to find a fit.
96 The second element can also be a function. In that case, it will be
97 called narrowed to the headers with the first element of the rule as
98 the argument. It should return a non-nil value if it thinks that the
99 mail belongs in that group.
103 This variable can also have a function as its value, and it can
104 also have a fancy split method as its value. See
105 `nnmail-split-fancy' for an explanation of that syntax."
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 E.g.:
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)."
200 function
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."
245 ;; revision 5.29 / p0-85 / Gnus 5.9
246 ;; Variable removed in No Gnus v0.7
249 "If non-nil, re-split incoming procmail sorted mail."
254 "If non-nil, scan all incoming procmail sorted mails once.
255 It scans low-level sorted spools even when not required."
261 "Function called to delete files in some mail backends."
267 'copy-file
269 "Function called to create a copy of a file.
270 This is `add-name-to-file' by default, which means that crossposts
271 will use hard links. If your file system doesn't allow hard
272 links, you could set this variable to `copy-file' instead."
281 nil)
282 "Hook that will be run after the incoming mail has been transferred.
283 The incoming mail is moved from the specified spool file (which normally is
285 directory. This hook is called after the incoming mail box has been
286 emptied, and can be used to call any mail box programs you have
289 E.g.:
292 (lambda ()
295 ;; The incoming mail box file.
296 (expand-file-name (user-login-name)
297 rmail-spool-directory))))
299 If you have xwatch running, this will alert it that mail has been
300 read.
302 If you use `display-time', you could use something like this:
305 (lambda ()
306 ;; Update the displayed time, since that will clear out
307 ;; the flag that says you have mail.
314 "Hook called before treating incoming mail.
315 The hook is run in a buffer with all the new, incoming mail."
320 "Hook called narrowed to the headers of each message.
321 This can be used to remove excessive spaces (and stuff like
322 that) from the headers before splitting and saving the messages."
327 "Hook called narrowed to each message."
332 "Regexp that matches list identifiers to be removed.
333 This can also be a list of regexps."
340 "Hook called just before starting to handle new incoming mail."
345 "Hook called just after finishing handling new incoming mail."
350 "Hook called before deciding where to split an article.
351 The functions in this hook are free to modify the buffer
352 contents in any way they choose -- the buffer contents are
353 discarded after running the split process."
358 "A hook called when a new article is spooled."
364 "The number of articles which indicates a large newsgroup or nil.
365 If the number of articles is greater than the value, verbose
366 messages will be shown to indicate the current status."
372 "Widget for customizing splits in the variable of the same name."
386 function
388 )
392 function
396 regexp symbol)
398 regexp
404 regexp))
405 nnmail-split-fancy)
409 "Incoming mail can be split according to this fancy variable.
410 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
412 The format of this variable is SPLIT, where SPLIT can be one of
413 the following:
415 GROUP: Mail will be stored in GROUP (a string).
417 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
418 field FIELD (a regexp) contains VALUE (a regexp), store the messages
419 as specified by SPLIT. If RESTRICT (a regexp) matches some string
420 after FIELD and before the end of the matched VALUE, return nil,
421 otherwise process SPLIT. Multiple RESTRICTs add up, further
422 restricting the possibility of processing SPLIT.
424 \(| SPLIT...): Process each SPLIT expression until one of them matches.
425 A SPLIT expression is said to match if it will cause the mail
426 message to be stored in one or more groups.
428 \(& SPLIT...): Process each SPLIT expression.
430 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
431 the buffer containing the message headers. The return value FUNCTION
432 should be a split, which is then recursively processed.
434 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
435 return value FUNCTION should be a split, which is then recursively
436 processed.
438 junk: Mail will be deleted. Use with care! Do not submerge in water!
439 Example:
440 (setq nnmail-split-fancy
442 ...other.rules.omitted...))
444 FIELD must match a complete field name. VALUE must match a complete
445 word according to the `nnmail-split-fancy-syntax-table' syntax table.
448 FIELD and VALUE can also be Lisp symbols, in that case they are expanded
449 as specified in `nnmail-split-abbrev-alist'.
454 Example:
457 nnmail-split-fancy
458 ;; Messages from the mailer daemon are not crossposted to any of
459 ;; the ordinary groups. Warnings are put in a separate group
460 ;; from real errors.
463 ;; Non-error messages are crossposted to all relevant
464 ;; groups, but we don't crosspost between the group for the
465 ;; (ding) list and the group for other (ding) related mail.
468 ;; Other mailing lists...
471 ;; Both lists below have the same suffix, so prevent
472 ;; cross-posting to mkpkg.list of messages posted only to
473 ;; the bugs- list, but allow cross-posting when the
474 ;; message was really cross-posted.
477 ;;
478 ;; People...
480 ;; Unmatched mail goes to the catch all group.
492 "Alist of abbreviations allowed in `nnmail-split-fancy'."
497 "The approximate number of Message-IDs nnmail will keep in its cache.
498 If this variable is nil, no checking on duplicate messages will be
499 performed."
506 "The file name of the nnmail Message-ID cache."
512 "If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
513 Three values are valid: nil, which means that nnmail is not to keep a
514 Message-ID cache; `warn', which means that nnmail should insert extra
515 headers to warn the user about the duplication (this is the default);
516 and `delete', which means that nnmail will delete duplicated mails.
518 This variable can also be a function. It will be called from a buffer
519 narrowed to the article in question with the Message-ID as a
520 parameter. It should return nil, `warn' or `delete'."
527 "Extra headers to parse.
528 In addition to the standard headers, these extra headers will be
529 included in NOV headers (and the like) when backends parse headers."
535 "Header lines longer than this limit are excluded from the split function."
541 "Default charset to be used when splitting incoming mail."
547 "Whether the nnmail splitting functionality should MIME decode headers."
553 "Whether to match partial words when fancy splitting.
554 Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
556 surrounded
557 by anything."
564 This avoids the creation of multiple groups when users send to an address
565 using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
570 ;;; Internal variables.
580 ;; support the %-hack
582 table)
592 \f
601 mm-text-coding-system
605 "Coding system for file name."
610 "Insert FILE in server buffer safely."
620 t)
624 "Make file name for GROUP."
629 ?. ?_))
631 ;; If this directory exists, we use it directly.
636 ;; If not, we translate dots into slashes.
639 dir))))
643 "Returns an assoc of group names and active ranges.
644 nn*-request-list should have been called before calling this function."
645 ;; Go through all groups from the active list.
650 "Parse the active file in the current buffer and return an alist."
658 group-assoc group max min)
669 group-assoc)))
673 group-assoc))
676 "Coding system for active file."
681 "Save GROUP-ASSOC in ACTIVE-FILE."
689 "Generate an active file from group-alist ALIST."
700 "Find out whether this FILE is to be split into GROUP only.
701 If SOURCE is a directory spec, try to return the group name component."
707 nil)))
708 nil))
713 start message-id content-length do-search end)
723 ;; Skip all the headers in case there are more "From "s...
728 ;; Unquote the ">From " line, if any.
734 ;; Find the Message-ID header.
740 ;; There is no Message-ID here, so we create one.
748 ;; Look for a Content-Length header.
756 ;; We destroy the header, since none of
757 ;; the backends ever use it, and we do not
758 ;; want to confuse other mailers by having
759 ;; a (possibly) faulty header.
772 ;; Go to the beginning of the next article - or to the end
773 ;; of the buffer.
787 count))
790 "Put point at the beginning of the next Unix mbox message."
791 ;; Algorithm used to find the next article in the
792 ;; brain-dead Unix mbox format:
793 ;;
794 ;; 1) Search for "^From ".
795 ;; 2) If we find it, then see whether the previous
796 ;; line is blank and the next line looks like a header.
797 ;; Then it's possible that this is a mail delim, and we use it.
799 found)
819 "Put point at the beginning of the current Unix mbox message."
820 ;; Algorithm used to find the next article in the
821 ;; brain-dead Unix mbox format:
822 ;;
823 ;; 1) Search for "^From ".
824 ;; 2) If we find it, then see whether the previous
825 ;; line is blank and the next line looks like a header.
826 ;; Then it's possible that this is a mail delim, and we use it.
828 found)
850 start message-id content-length end skip head-end)
854 ;; Possibly wrong format?
858 ;; Carry on until the bitter end.
861 end nil)
862 ;; Find the end of the head.
864 start
867 ;; This will never happen, but just to be on the safe side --
868 ;; if there is no head-body delimiter, we search a bit manually.
873 ;; Find the Message-ID header.
881 ;; There is no Message-ID here, so we create one.
884 ;; Look for a Content-Length header.
890 ;; We destroy the header, since none of the backends ever
891 ;; use it, and we do not want to confuse other mailers by
892 ;; having a (possibly) faulty header.
896 ;; Find the end of this article.
900 ;; We try the Content-Length value. The idea: skip over the header
901 ;; separator, then check what happens content-length bytes into the
902 ;; message body. This should be either the end of the buffer, the
903 ;; message separator or a blank line followed by the separator.
904 ;; The blank line should probably be deleted. If neither of the
905 ;; three is met, the content-length header is probably invalid.
920 ;; No Content-Length, so we find the beginning of the next
921 ;; article or the end of the buffer.
925 ;; Allow the backend to save the article.
934 count))
940 start message-id end)
944 ;; Possibly wrong format?
946 ;; Carry on until the bitter end.
949 ;; Find the end of the head.
951 start
954 ;; This will never happen, but just to be on the safe side --
955 ;; if there is no head-body delimiter, we search a bit manually.
960 ;; Find the Message-ID header.
964 ;; There is no Message-ID here, so we create one.
972 ;; Find the end of this article.
978 ;; Allow the backend to save the article.
988 count))
991 ;; In a maildir, every file contains exactly one mail.
993 message-id)
995 ;; Find the end of the head.
1000 ;; This will never happen, but just to be on the safe side --
1001 ;; if there is no head-body delimiter, we search a bit manually.
1006 ;; Find the Message-ID header.
1010 ;; There is no Message-ID here, so we create one.
1018 ;; Allow the backend to save the article.
1029 group artnum-func junk-func)
1030 "Go through the entire INCOMING file and pick out each individual mail.
1031 FUNC will be called with the buffer narrowed to each mail.
1032 INCOMING can also be a buffer object. In that case, the mail
1033 will be copied over from that buffer."
1035 ;; methods to just this group.
1039 nnmail-split-methods))
1041 ;; Insert the incoming file.
1050 0
1053 ;; Handle both babyl, MMDF and unix mail formats, since
1054 ;; movemail will use the former when fetching from a
1055 ;; mailbox, the latter when fetching from a file.
1061 func artnum-func junk-func))
1071 "Look at the headers and return an alist of groups that match.
1072 FUNC will be called with the group name to determine the article number."
1075 group-art method grp)
1079 ;; If there is only just one group to put everything in, we
1080 ;; just return a list with just this one method in.
1083 ;; We do actual comparison.
1084 ;; Copy the article into the work buffer.
1088 ;; Narrow to headers.
1095 ;; Decode MIME headers and charsets.
1099 ;; Fold continuation lines.
1103 ;; Nuke pathologically long headers. Since Gnus applies
1104 ;; pathologically complex regexps to the buffer, lines
1105 ;; that are looong will take longer than the Universe's
1106 ;; existence to process.
1110 nnmail-split-header-length-limit)
1113 ;; Allow washing.
1122 ;; Not a regular split method, so it has to be a
1123 ;; fancy one.
1131 nnmail-split-methods
1135 ;; `nnmail-split-methods' is a function, so we
1136 ;; just call this function here and use the
1137 ;; result.
1147 ;; The article may be "cross-posted" to `junk'. What
1148 ;; to do? Just remove the `junk' spec. Don't really
1149 ;; see anything else to do...
1151 junk-func)
1158 split))))
1159 ;; Go through the split methods to find a match.
1173 nil t)))
1176 pos)
1177 ;; Function to say whether this is a match.
1179 ;; Don't enter the article into the same
1180 ;; group twice.
1183 group-art))
1184 ;; This is the final group, which is used as a
1185 ;; catch-all.
1192 ;; Fall back on "bogus" if all else fails.
1196 ;; Produce a trace if non-empty.
1208 ;; See whether the split methods returned `junk'.
1210 nil
1211 ;; The article may be "cross-posted" to `junk'. What
1212 ;; to do? Just remove the `junk' spec. Don't really
1213 ;; see anything else to do...
1220 "Insert how many lines there are in the body of the mail.
1221 Return the number of characters in the body."
1236 chars)))
1239 "Insert an Xref line based on the (group . article) alist."
1259 ;;; Message washing functions
1262 "Remove excessive whitespace from all headers."
1268 "Remove list identifiers from Subject headers."
1272 nnmail-list-identifiers)))
1277 nil t)
1281 nil t)
1286 "Translate TAB characters into SPACE characters."
1291 "Header line matching mailer producing bogus References lines.
1292 See `nnmail-ignore-broken-references'."
1298 "Ignore the References line and use In-Reply-To
1300 Eudora has a broken References line, but an OK In-Reply-To."
1317 ;;; Utility functions
1323 "Utility function to directly post a message to an nnmail-derived group.
1324 Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1325 to actually put the message in the right group."
1334 to-newsgroup))
1336 to-newsgroup gnus-command-method)
1338 gnus-command-method))
1345 "Fancy splitting method.
1346 See the documentation for the variable `nnmail-split-fancy' for details."
1351 ;; Alist of split expressions their equivalent regexps.
1354 ;; Return a list of groups matching SPLIT.
1357 ;; nil split
1359 nil)
1361 ;; A group name. Do the \& and \N subs into the string.
1367 ;; Junk the message.
1373 ;; Builtin & operation.
1377 ;; Builtin | operation.
1383 done))
1385 ;; Builtin : operation.
1391 ;; Builtin ! operation.
1395 ;; Check the cache for the regexp for this split.
1398 match-data
1410 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1411 ;; So, start-of-value is the point just before the
1412 ;; beginning of the value, whereas after-header-name
1413 ;; is the point just after the field name.
1416 ;; Start the next search just before the beginning of the
1417 ;; VALUE match.
1419 ;; Handle - RESTRICTs
1421 ;; RESTRICT must start after-header-name and
1422 ;; end after start-of-value, so that, for
1423 ;; (any "foo" - "x-foo" "foo.list")
1424 ;; we do not exclude foo.list just because
1425 ;; the header is: ``To: x-foo, foo''
1428 after-header-name t)
1434 ;; Someone might want to do a \N sub on this match, so
1435 ;; restore the match data.
1440 split-result))
1442 ;; Not in cache, compute a regexp for the field/value pair.
1447 partial-front
1448 partial-rear
1449 regexp)
1456 ;; Same trick for the rear of the regexp
1461 ;; Invert the match-partial-words behavior if the optional
1462 ;; last element is specified.
1467 nnmail-split-fancy-match-partial-words)
1473 field)
1477 value
1481 ;; Now that it's in the cache, just call nnmail-split-it again
1482 ;; on the same split, which will find it immediately in the cache.
1488 c expanded beg N did-expand)
1497 ;; We hit a \; expand it.
1504 ;; \ followed by some character we don't expand.
1506 ;; \& or \N
1510 ;; We wrapped the searches in parentheses, so we have to
1511 ;; add some parentheses here...
1519 expanded))))
1523 newtext)))
1525 ;; Activate a backend only if it isn't already activated.
1526 ;; If FORCE, re-read the active file even if the backend is
1527 ;; already activated.
1532 force
1535 backend)))))
1542 backend)))
1552 file-time))
1554 t))
1559 ;;;
1560 ;;; nnmail duplicate handling
1561 ;;;
1581 nnmail-treat-duplicates
1585 ;; Weed out the excess number of Message-IDs.
1591 ;; Save the buffer.
1594 t))
1603 ;; this will handle cases like `B r' where the group is nil
1606 id grp subject sender))
1608 ;; Store some information about the group this message is written
1609 ;; to. This is passed in as the grp argument -- all locations this
1610 ;; has been called from have been checked and the group is available.
1611 ;; The only ambiguous case is nnmail-check-duplication which will only
1612 ;; 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.
1657 ;; Function for nnmail-split-fancy: look up all references in the
1658 ;; cache and if a match is found, return that group.
1660 "Split this message into the same group as its parent.
1661 This function can be used as an entry in `nnmail-split-fancy', for
1662 example like this: (: nnmail-split-fancy-with-parent)
1663 For a message to be split, it looks for the parent message in the
1664 References or In-Reply-To header and then looks in the message id
1665 cache file (given by the variable `nnmail-message-id-cache-file') to
1666 see which group that message was put in. This group is returned.
1668 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1676 nnmail-split-fancy-with-parent-ignore-groups
1678 nnmail-split-fancy-with-parent-ignore-groups)))
1688 res)))
1705 ;; If this is a duplicate message, then we do not save it.
1711 nnmail-treat-duplicates)
1715 nnmail-treat-duplicates))))
1716 group-art)
1717 ;; We insert a line that says what the mail source is.
1724 ;; Let the backend save the article (or not).
1729 artnum-func nil junk-func))))
1734 ;; We insert a warning.
1746 ;; Add the group-art list to the history list.
1751 ;;; Get new mail.
1762 "Read new incoming mail."
1766 "Tell us whether the mail-sources specify that `nnmail-get-new-mail' should
1767 be called once per group or once for all groups."
1772 group in-group spool-func)
1774 fetching-sources
1778 source)
1780 sources)
1782 ;; Use group's parameter
1784 group)
1791 group group spool-func))
1793 ;; Hack to only fetch the contents of a single group's spool file.
1796 group)
1800 :predicate
1812 ;; We first activate all the groups.
1814 ;; Allow the user to hook.
1816 ;; Open the message-id cache.
1818 ;; The we go through all the existing mail source specification
1819 ;; and fetch the mail from each.
1824 source
1829 ',spool-func
1832 nil
1841 ;; If we did indeed read any incoming spools, we save all info.
1853 total))
1854 ;; Close the message-id cache.
1856 ;; Allow the user to hook.
1860 "Say whether an article that is TIME old in GROUP should be expired.
1861 If TIME is nil, then return the cutoff time for oldness instead."
1865 t)
1868 nnmail-expiry-wait)))
1871 inhibit))
1872 ;; This isn't an expirable group.
1873 nil)
1875 ;; We expire all articles on sight.
1878 t))
1880 ;; This is an ange-ftp group, and we don't have any dates.
1881 nil)
1884 ;; Compare the time with the current time.
1892 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1893 ;; that buffer if the nnfolder group isn't selected.
1895 ;; Don't enter Message-IDs into cache.
1896 ;; Let users hack it in TARGET function.
1908 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1925 ;; If the header is to-from then match against the
1926 ;; To or From header
1945 "Check (and modify) the syntax of the message in the current buffer."
1953 "Do a `write-region', and then set the file modes."
1959 ;;;
1960 ;;; Status functions
1961 ;;;
1964 "Make status NAME and VALUE part of the current status line."
1976 "Return a status-value alist from STATUS."
1981 ;; Narrow to the status.
1987 ;; Go through all elements and add them to the list.
1992 ;; Implied "yes".
1997 ;; Implied "no".
1999 ;; Unquoted value.
2002 ;; Quoted value.
2005 status)))
2008 "Return a status string from STATUS."
2019 "Generate an overview of where the last mail split put articles."
2029 elem
2034 "Remove all instances of GROUP from `nnmail-split-history'."
2043 "Say whether GROUP has new mail."
2045 found)
2049 his nil)))
2050 found))
2053 "Check to see if point is within the headers of a unix mail message.
2054 Doesn't change point."
2064 ;;; nnmail.el ends here