public-inbox-imapd(1)

1PUBLIC-INBOX-IMAPD(1)      public-inbox user manual      PUBLIC-INBOX-IMAPD(1)
2
3
4

NAME

6       public-inbox-imapd - IMAP server for sharing public-inboxes
7

SYNOPSIS

9         public-inbox-imapd [OPTIONS]
10

DESCRIPTION

12       public-inbox-imapd provides a read-only IMAP daemon for public-inbox.
13       It uses options and environment variables common to all
14       public-inbox-daemon(8) implementations.
15
16       Like public-inbox-nntpd(1) and public-inbox-httpd(1),
17       "public-inbox-imapd" will never require write access to the directory
18       where the public-inboxes are stored, so it may be run as a different
19       user than the user running public-inbox-watch(1), public-inbox-mda(1),
20       or git-fetch(1).
21

OPTIONS

23       See common options in "OPTIONS" in public-inbox-daemon(8).
24       Additionally, IMAP-specific behavior for certain options are supported
25       and documented below.
26
27       -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
28       --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
29           In addition to the normal "-l"/"--listen" switch described in
30           public-inbox-daemon(8), the "PROTO" prefix (e.g. "imap://" or
31           "imaps://") may be specified to force a given protocol.
32
33           For STARTTLS and IMAPS support, the "cert" and "key" may be
34           specified on a per-listener basis after a "?" character and
35           separated by ",".  These directives are per-directive, and it's
36           possible to use a different cert for every listener.
37
38       --cert /path/to/cert
39           The default TLS certificate for optional STARTTLS and IMAPS support
40           if the "cert" option is not given with "--listen".
41
42           If using systemd-compatible socket activation and a TCP listener on
43           port 993 is inherited, it is automatically IMAPS when this option
44           is given.  When a listener on port 143 is inherited and this option
45           is given, it automatically gets STARTTLS support.
46
47       --key /path/to/key
48           The default private TLS certificate key for optional STARTTLS and
49           IMAPS support if the "key" option is not given with "--listen".
50           The private key may concatenated into the path used by "--cert", in
51           which case this option is not needed.
52

CONFIGURATION

54       "public-inbox-imapd" uses the same configuration knobs as
55       public-inbox-nntpd(1), see public-inbox-nntpd(1) and
56       public-inbox-config(5).
57
58       publicinbox.<name>.newsgroup
59               The newsgroup name maps to an IMAP folder name.
60

CONTACT

62       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
63
64       The mail archives are hosted at <https://public-inbox.org/meta/>, and
65       <nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
66       <nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
67

COPYRIGHT

69       Copyright 2020-2021 all contributors <mailto:meta@public-inbox.org>
70
71       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
72