diff options
Diffstat (limited to 'mboxu.5')
| -rw-r--r-- | mboxu.5 | 35 |
1 files changed, 23 insertions, 12 deletions
@@ -10,32 +10,43 @@ .Sh DESCIPTION .Pp .Nm -is a simple and readable mbox-like format, in which messages are encoded in UTF-8. +is an mbox-like format, in which messages are encoded in UTF-8. -In addition, .Nm -forbids the inclusion of multipart messages inside the mbox database. -Only the +also forbids the inclusion of multipart messages inside the mbox database. +The body of a message must contain a single .Em canonical -part, formatted in plain-text UTF-8, is included inside the mbox file. -Other parts, such as images, should be stored in separate local files and referenced via an -.Ql Attachment +part in plain-text UTF-8. +Other parts, such as images, should be stored in separate local or remote files and referenced via a +.Ql Reference header: . .Bd -literal -offset indent -Attachment: att/review.pdf +Reference: att/review.pdf .Ed . .Pp Paths in the -.Ql Attachment +.Ql Reference header are relative to the location of the mbox database, unless they begin with a forward slash. +If a path begins with a protocol, such as http:// or ftp://, it should be regarded as remote. .Pp +Messages are separated by a complete and correctly formatted +.Ql From\ +line. +Lines in message bodies beginning with +.Ql From\ +are not quoted. +.Pp +.Nm +is not particularly suitable for storing +.Dq standard +internet mail. +Rather, it should be used for more specific purposes, such as the storage of local data or of mail propagated in a specialized network not meant to be interoperable with the general e-mail network. +.Pp +Despite its differences from the standard mbox format, .Nm is readable by most modern mail readers. -Attachments are not directly visible, but can be accessed manually through the -.Ql Attachment -headers. . .Sh RATIONALE .Pp |