aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 0261a2f236ff6e9f023d479659fa40e6e48615bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#+TITLE: guile-email

guile-email is a collection of email utilities implemented in pure
guile. It supports parsing RFC5322 compliant email messages, and
Multipurpose Internet Mail Extensions (MIME) compliant email messages
as specified in RFC2045, RFC2046, RF2047 and RFC2049.

guile-email is used by [[https://git.elephly.net/software/mumi.git][mumi]], a web interface to the [[https://www.debian.org/Bugs/][Debbugs]] bug
tracker. Mumi is primarily used by [[https://www.gnu.org/software/guix/][the Guix project]] at
https://issues.guix.info.

* Features

- Parse [[https://tools.ietf.org/html/rfc5322][RFC5322]] compliant email messages (currently does not support
  [[https://tools.ietf.org/html/rfc5322#section-4][obsolete syntax]])
- Parse MIME compliant email messages as specified in [[https://tools.ietf.org/html/rfc2045][RFC2045]],
  [[https://tools.ietf.org/html/rfc2046][RFC2046]], [[https://tools.ietf.org/html/rfc2047][RFC2047]] and [[https://tools.ietf.org/html/rfc2049][RFC2049]]
- Parse non-standard [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Mail-Headers.html][Emacs message mode parens style addresses]]
- Encode and decode Quoted-Printable encoding, Base64 encoding and
  Q-encoding

* Documentation

[[https://guile-email.systemreboot.net/manual/][Documentation for guile-email]] is available online. If guile-email is
installed on your machine, you may also read the manual using your
info browser.

* Future work

- Support obsolete syntax as specified in RFC5322
- Support MIME parameter value and encoded word extensions specified
  in RFC2231
- Support email generation

* Contributing

Feedback, suggestions, feature requests, bug reports and patches are
all welcome. Please write to the mailing list at
[[mailto:guile-email@systemreboot.net][guile-email@systemreboot.net]].

* License

guile-email is free software released under the terms of the [[https://www.gnu.org/licenses/agpl.html][GNU
Affero General Public License]], either version 3 of the License, or
(at your option) any later version.