blob: 77f93fadeb93d81986651694ee175362cb5a4109 (
plain) (
blame)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
.Dd April 14, 2020
.Dt BUBGER 1
.Os
.
.Sh NAME
.Nm bubger
.Nd IMAP archive renderer
.
.Sh SYNOPSIS
.Nm
.Op Fl v
.Op Fl C Ar path
.Op Fl a Ar algo
.Op Fl h Ar head
.Op Fl p Ar port
.Op Fl s Ar search
.Op Fl t Ar title
.Op Fl u Ar base
.Op Fl w Ar file
.Ar host
.Ar user
.Op Ar mailbox
.
.Sh DESCRIPTION
The
.Nm
utility renders an HTML, Atom and mboxrd archive
of an IMAP mailbox
arranged into threads.
.
.Pp
The arguments are as follows:
.
.Bl -tag -width Ds
.It Fl C Ar path
Change directory to
.Ar path
before reading and writing files.
.
.It Fl a Ar algo
Set the threading algorithm to one of
.Sy ORDEREDSUBJECT
or
.Sy REFERENCES .
The default algorithm is
.Sy REFERENCES .
.
.It Fl h Ar head
Add the contents of the file
.Ar head
to the
.Sy <head>
element of HTML pages.
.
.It Fl p Ar port
Connect to IMAP on
.Ar port .
The default port is
.Sy imaps
.Pq 993 .
TLS without STARTTLS is assumed.
.
.It Fl s Ar search
Limit threads to messages matching
.Ar search .
The default search is
.Sy ALL .
.
.It Fl t Ar title
Set the base title for HTML pages.
The default title is the mailbox name.
.
.It Fl u Ar base
Set the base URL for links in Atom feeds.
.
.It Fl v
Log IMAP protocol to standard error.
.
.It Fl w Ar file
Read the IMAP password from
.Ar file .
By default the password is set by the
.Ev BUBGER_IMAP_PASSWORD
environment variable.
.
.It Ar host
Connect to IMAP on
.Ar host .
.It Ar user
Log in to IMAP as
.Ar user .
.
.It Ar mailbox
Render messages from
.Ar mailbox .
The default mailbox is
.Qq Archive .
.El
.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev BUBGER_IMAP_PASSWORD
The IMAP password.
.El
.
.Sh FILES
.Bl -tag -width Ds
.It Pa UIDVALIDITY
Stores the mailbox UID validity.
.It Pa UIDNEXT
Stores the next UID of the mailbox.
.It Pa UID/*.atom , Pa UID/*.html , Pa UID/*.mbox
Cached Atom, HTML and mboxrd fragments for each message.
.It Pa message/*.mbox
Rendered mboxrd files for each message.
.It Pa thread/*.atom , Pa thread/*.html , Pa thread/*.mbox
Rendered Atom, HTML and mboxrd files for each thread.
.El
.
.Sh STANDARDS
.Bl -item
.It
.Rs
.%A E. Levinson
.%T Content-ID and Message-ID Uniform Resource Locators
.%I IETF
.%N RFC 2392
.%D August 1998
.%U https://tools.ietf.org/html/rfc2392
.Re
.It
.Rs
.%A M. Crispin
.%T INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1
.%I IETF
.%N RFC 3501
.%D March 2003
.%U https://tools.ietf.org/html/rfc3501
.Re
.It
.Rs
.%A M. Crispin
.%A K. Murchison
.%T Internet Message Access Protocol - SORT and THREAD Extensions
.%I IETF
.%N RFC 5256
.%D June 2008
.%U https://tools.ietf.org/html/rfc5256
.Re
.It
.Rs
.%A M. Nottingham
.%A R. Sayre
.%T The Atom Syndication Format
.%I IETF
.%N RFC 4287
.%D December 2005
.%U https://tools.ietf.org/html/rfc4287
.Re
.It
.Rs
.%A T. Berners-Lee
.%A L. Masinter
.%A M. McCahill
.%T Uniform Resource Locators (URL)
.%I IETF
.%N RFC 1738
.%D December 1994
.%U https://tools.ietf.org/html/rfc1738
.Re
.El
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
|