summaryrefslogtreecommitdiff
path: root/mboxu.5
blob: 138028260d1410fcd52e7b214f5f13a8c2d72342 (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
.Dd $Mdocdate$
.Dt mboxu 5
.Os
.
.Sh NAME
.Nm mboxu
.Nd mbox in UTF-8
.
.
.Sh DESCIPTION
.Pp
.Nm
is a simple and readable mbox-like format, in which messages are encoded directly in UTF-8.

Messages are differentiated from one another via a line beginning with
.Ql From\  ,
.Em followed by at least one header line .

Otherwise,
.Nm
is identical to traditional mbox.
.
.Sh RATIONALE
.Pp
.Nm
has two goals:
.Bl -enum
.It
to be easily writable and readable by humans, and
.It
to be easily generated and parsed by machines.
.El
.Pp
Normally, non-ASCII e-mail messages must be encoded in base64 or quoted-printable, rendering them more or less unreadable in raw form.
Mailboxes using
.Nm ,
on the other hand, do not require any decoding to be read by a human.

Likewise,
.Nm
is much easier to generate and manually write than standard mbox.
.
.Sh FUTURE
.Pp
In the future, a readable alternative to multipart messages may be added, where non-canonical parts are stored in separate files and referenced via some
.Ql Attachment:
header.
.Pp
If that is added, a translator between
.Nm
and standard mbox might be desirable.
.
.Sh AUTHORS
.Pp
.Nm
is created by John Ankarström
.Aq Mt john (at) ankarstrom.se .