.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "LEI-MAIL-FORMATS 5" .TH LEI-MAIL-FORMATS 5 1993-10-02 public-inbox.git "public-inbox user manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME lei\-mail\-formats \- description of mail formats supported by lei .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBlei\-q\fR\|(1) supports writing to several existing mail formats for interoperability with existing mail user agents (MUA); below is an overview of them to help users choose. .SH Maildir .IX Header "Maildir" The default output format when given a filesystem path, it supports parallel read\-write access. Performance is acceptable for smaller directories, but degrades as mailboxes get larger. Speed and scalability are limited by kernel and filesystem performance due to the use of small files and large number of syscalls. .PP See also: and .SH "Mbox family" .IX Header "Mbox family" The mbox family consists of several incompatible formats. Locking for parallel access is supported, but may not be compatible across tools. With compression (e.g. \fBgzip\fR\|(1)), they require the least amount of space while offering good read\-only performance. .PP Keyword updates (\f(CW\*(C`Status:\*(C'\fR and/or \f(CW\*(C`X\-Status:\*(C'\fR headers) generally require rewriting the entire mbox. .PP See also: , \&\fBmbox\fR\|(5) .SS mboxo .IX Subsection "mboxo" The traditional BSD format. It quotes \f(CW\*(C`From \*(C'\fR to \f(CW\*(C`>From \*(C'\fR, but lines already beginning with \f(CW\*(C`>From \*(C'\fR do not get quoted, thus automatic reversibility is not guaranteed. MUAs which favor "mboxcl" or "mboxcl2" may convert these automatically to their preferred format. .PP Truncation is undetectable unless compressed with gzip or similar. .SS mboxrd .IX Subsection "mboxrd" An evolution of "mboxo", but quotes \f(CW\*(C`From \*(C'\fR lines prefixed with any number of \f(CW\*(C`>\*(C'\fR characters and is thus fully reversible. .PP This format is emitted by \fBPublicInbox::WWW\fR\|(3pm) with gzip. Since git 2.10, \f(CW\*(C`git am \-\-patch\-format=mboxrd\*(C'\fR reads this format. \f(CW\*(C`git log\*(C'\fR and \f(CW\*(C`git format\-patch \-\-stdout\*(C'\fR can also generate this format with the \f(CW\*(C`\-\-pretty=mboxrd\*(C'\fR switch. .PP As with uncompressed "mboxo", uncompressed mboxrd are vulnerable to undetectable truncation. .PP It gracefully degrades to being treated as "mboxo" by MUAs unaware of the format as excessive \f(CW\*(C`>From \*(C'\fR quoting is recognizable to humans. .SS mboxcl .IX Subsection "mboxcl" "mboxo" with a \f(CW\*(C`Content\-Length:\*(C'\fR header, \f(CW\*(C`From \*(C'\fR lines remain quoted to retain readability with "mboxo" and "mboxrd" MUAs. However, it is easy to corrupt these files when using tools which are not aware of \f(CW\*(C`Content\-Length:\*(C'\fR and write out updates as "mboxo". .PP \&\fBmutt\fR\|(1) will convert "mboxo" and "mboxrd" to mboxcl upon opening. .PP See also: .SS mboxcl2 .IX Subsection "mboxcl2" Like "mboxcl", but without \f(CW\*(C`From \*(C'\fR any quoting. It is wholly incompatible with MUAs which only handle "mboxo" and/or "mboxrd". This is format is generated by \fBmutt\fR\|(1) when writing to a new mbox. .SH MH .IX Header "MH" Preliminary support for reads as of 2.0.0. Locking semantics differ incompatibly amongst existing writers: Python and nmh appear compatible with each other, while mutt appears racy and unsuitable for parallel access due to \fBrename\fR\|(2) potentially clobbering the \&\f(CW\*(C`.mh_sequences\*(C'\fR file. More info about other clients is greatly appreciated. .PP Sequence numbers may be packed and reused by some writers, so lei users may need to run \fBlei\-refresh\-mail\-sync\fR\|(1) if inotify|kevent missed packing while \fBlei\-daemon\fR\|(8) wasn\*(Aqt running. .PP lei is safe for reading mlmmj archives as MH since mlmmj neither packs nor uses a .mh_sequences file to store state. .SH MMDF .IX Header "MMDF" Not yet supported, and it\*(Aqs unclear if current usage/support makes it worth supporting. .SH IMAP .IX Header "IMAP" Depending on the IMAP server software and configuration, IMAP servers may use any (or combination) of the aforementioned formats or a non\-standard database backend. Currently, lei uses Mail::IMAPClient which has acceptable performance over low\-latency links. Performance over high\-latency links is currently poor. .SH eml .IX Header "eml" A single raw message file. \f(CW\*(C`eml\*(C'\fR is not an output format for lei, but accepted by as an \f(CW\*(C`\-\-input\-format\*(C'\fR (\f(CW\*(C`\-F\*(C'\fR) for read\-only commands such as \fBlei\-tag\fR\|(1) and \fBlei\-import\fR\|(1). .PP Since \f(CW\*(C`eml\*(C'\fR is the suffix for the \f(CW\*(C`message/rfc822\*(C'\fR MIME type (according to the \f(CW\*(C`mime.types\*(C'\fR file), lei will infer the type based on the \f(CW\*(C`.eml\*(C'\fR suffix if \f(CW\*(C`\-\-input\-format\*(C'\fR is unspecified .PP \&\f(CW\*(C`.patch\*(C'\fR\-suffixed files generated by \fBgit\-format\-patch\fR\|(1) (without \f(CW\*(C`\-\-stdout\*(C'\fR) are \f(CW\*(C`eml\*(C'\fR files with the addition of an mbox \f(CW\*(C`From \*(C'\fR header. \fBlei\fR\|(1) removes \f(CW\*(C`From \*(C'\fR lines to treat them as \f(CW\*(C`eml\*(C'\fR when reading these for compatibility with \&\f(CW\*(C`git\-am(1)\*(C'\fR and similar tools. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2021 all contributors .PP License: AGPL\-3.0+ .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBlei\fR\|(1), \fBlei\-q\fR\|(1), \fBlei\-convert\fR\|(1), \fBlei\-overview\fR\|(7)