3 public-inbox-imapd - IMAP server for sharing public-inboxes
7 public-inbox-imapd [OPTIONS]
11 public-inbox-imapd provides a read-only IMAP daemon for
12 public-inbox. It uses options and environment variables common
13 to all L<public-inbox-daemon(8)> implementations.
15 Like L<public-inbox-nntpd(1)> and L<public-inbox-httpd(1)>,
16 C<public-inbox-imapd> will never require write access
17 to the directory where the public-inboxes are stored, so it
18 may be run as a different user than the user running
19 L<public-inbox-watch(1)>, L<public-inbox-mda(1)>, or
24 See common options in L<public-inbox-daemon(8)/OPTIONS>.
25 Additionally, IMAP-specific behavior for certain options
26 are supported and documented below.
30 =item -l PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
32 =item --listen PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
34 In addition to the normal C<-l>/C<--listen> switch described in
35 L<public-inbox-daemon(8)>, the C<PROTOCOL> prefix (e.g. C<imap://> or
36 C<imaps://>) may be specified to force a given protocol.
38 For STARTTLS and IMAPS support, the C<cert> and C<key> may be specified
39 on a per-listener basis after a C<?> character and separated by C<,>.
40 These directives are per-directive, and it's possible to use a different
41 cert for every listener.
43 =item --cert /path/to/cert
45 The default TLS certificate for optional STARTTLS and IMAPS support
46 if the C<cert> option is not given with C<--listen>.
48 If using systemd-compatible socket activation and a TCP listener on port
49 993 is inherited, it is automatically IMAPS when this option is given.
50 When a listener on port 143 is inherited and this option is given, it
51 automatically gets STARTTLS support.
53 =item --key /path/to/key
55 The default private TLS certificate key for optional STARTTLS and IMAPS
56 support if the C<key> option is not given with C<--listen>. The private
57 key may be concatenated into the path used by C<--cert>, in which case this
64 C<public-inbox-imapd> uses the same configuration knobs
65 as L<public-inbox-nntpd(1)>, see L<public-inbox-nntpd(1)>
66 and L<public-inbox-config(5)>.
70 =item publicinbox.<name>.newsgroup
72 The newsgroup name maps to an IMAP folder name.
78 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
80 The mail archives are hosted at L<https://public-inbox.org/meta/>, and
81 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
82 L<nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
86 Copyright 2020-2021 all contributors L<mailto:meta@public-inbox.org>
88 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
92 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
93 L<public-inbox-config(5)>, L<public-inbox-nntpd(1)>