* nnmairix.el: Remove old documentation in the commentary block.
[gnus] / lisp / mail-parse.el
1 ;;; mail-parse.el --- Interface functions for parsing mail
2
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; This file is part of GNU Emacs.
8
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
13
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
21
22 ;;; Commentary:
23
24 ;; This file contains wrapper functions for a wide range of mail
25 ;; parsing functions.  The idea is that there are low-level libraries
26 ;; that impement according to various specs (RFC2231, DRUMS, USEFOR),
27 ;; but that programmers that want to parse some header (say,
28 ;; Content-Type) will want to use the latest spec.
29 ;;
30 ;; So while each low-level library (rfc2231.el, for instance) decodes
31 ;; faithfully according to that (proposed) standard, this library is
32 ;; the interface library.  If some later RFC supersedes RFC2231, one
33 ;; would just have to write a new low-level library, adjust the
34 ;; aliases in this library, and the users and programmers won't notice
35 ;; any changes.
36
37 ;;; Code:
38
39 (require 'mail-prsvr)
40 (require 'ietf-drums)
41 (require 'rfc2231)
42 (require 'rfc2047)
43 (require 'rfc2045)
44
45 (defalias 'mail-header-parse-content-type 'rfc2231-parse-qp-string)
46 (defalias 'mail-header-parse-content-disposition 'rfc2231-parse-qp-string)
47 (defalias 'mail-content-type-get 'rfc2231-get-value)
48 ;(defalias 'mail-header-encode-parameter 'rfc2045-encode-string)
49 (defalias 'mail-header-encode-parameter 'rfc2231-encode-string)
50
51 (defalias 'mail-header-remove-comments 'ietf-drums-remove-comments)
52 (defalias 'mail-header-remove-whitespace 'ietf-drums-remove-whitespace)
53 (defalias 'mail-header-strip 'ietf-drums-strip)
54 (defalias 'mail-header-get-comment 'ietf-drums-get-comment)
55 (defalias 'mail-header-parse-address 'ietf-drums-parse-address)
56 (defalias 'mail-header-parse-addresses 'ietf-drums-parse-addresses)
57 (defalias 'mail-header-parse-date 'ietf-drums-parse-date)
58 (defalias 'mail-narrow-to-head 'ietf-drums-narrow-to-header)
59 (defalias 'mail-quote-string 'ietf-drums-quote-string)
60 (defalias 'mail-header-make-address 'ietf-drums-make-address)
61
62 (defalias 'mail-header-fold-field 'rfc2047-fold-field)
63 (defalias 'mail-header-unfold-field 'rfc2047-unfold-field)
64 (defalias 'mail-header-narrow-to-field 'rfc2047-narrow-to-field)
65 (defalias 'mail-header-field-value 'rfc2047-field-value)
66
67 (defalias 'mail-encode-encoded-word-region 'rfc2047-encode-region)
68 (defalias 'mail-encode-encoded-word-buffer 'rfc2047-encode-message-header)
69 (defalias 'mail-encode-encoded-word-string 'rfc2047-encode-string)
70 (defalias 'mail-decode-encoded-word-region 'rfc2047-decode-region)
71 (defalias 'mail-decode-encoded-word-string 'rfc2047-decode-string)
72 (defalias 'mail-decode-encoded-address-region 'rfc2047-decode-address-region)
73 (defalias 'mail-decode-encoded-address-string 'rfc2047-decode-address-string)
74
75 (provide 'mail-parse)
76
77 ;; arch-tag: 3e63d75c-c962-4784-ab01-7ba07ca9d2d4
78 ;;; mail-parse.el ends here