summaryrefslogtreecommitdiff
path: root/README.org
blob: b7e93c256ba4f10351743d9e4f340aa3f905b1c6 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#+TITLE: guile-email
#+MACRO: ci-badge [[https://ci.systemreboot.net/jobs/$1][https://ci.systemreboot.net/badge/$1.svg]]

{{{ci-badge(guile-email-with-guile-2.2)}}} {{{ci-badge(guile-email-with-guile-3.0)}}} {{{ci-badge(guile-email-with-guile-3.0-latest)}}} {{{ci-badge(guile-email-nightly)}}} {{{ci-badge(guile-email-website)}}}

guile-email is a collection of email utilities implemented in pure
guile. It supports parsing MIME (Multipurpose Internet Mail
Extensions) compliant email messages and reading emails from the mbox
format.

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.
- the [[https://data.guix.gnu.org/][Guix data service]], also used by the Guix project

* 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
- Read emails from the [[https://en.wikipedia.org/wiki/Mbox][mbox format]]

* Download

[[https://repology.org/project/guile-email/versions][https://repology.org/badge/vertical-allrepos/guile-email.svg]]

Download release tarballs.

#+BEGIN: releases
#+END:

Download [[https://systemreboot.net/files/misc/arunisaac.pub][public signing key]].

Browse the [[https://git.systemreboot.net/guile-email][development version]] of guile-email hosted in a git
repository.

* Documentation

[[https://guile-email.systemreboot.net/manual/dev/en/][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 decoding PGP encrypted/signed messages
- Support email generation

* Contributing

Feedback, suggestions, feature requests, bug reports and patches are
all welcome. Please write to the public inbox at
[[mailto:guile-email@systemreboot.net][guile-email@systemreboot.net]]. You may also [[https://lists.systemreboot.net/guile-email/new.atom][subscribe]] to the public
inbox or browse the [[https://lists.systemreboot.net/guile-email][archives]] of previous discussions.

* Contributors
  Thanks to these wonderful people! :-)
  - Christopher Baines :: bug reports
  - Mark H Weaver :: bug reports
  - Mathieu Othacehe :: code
  - Ricardo Wurmus :: bug reports

* 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.