public-inbox-pop3d(1)

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

NAME

6       public-inbox-pop3d - POP3 server for sharing public-inboxes
7

SYNOPSIS

9         public-inbox-pop3d [OPTIONS]
10

DESCRIPTION

12       public-inbox-pop3d provides a POP3 daemon for public-inbox.  It uses
13       options and environment variables common to all read-only
14       public-inbox-daemon(8) implementations, but requires additional read-
15       write storage to keep track of deleted messages on a per-user basis.
16
17       Like public-inbox-imapd(1), "public-inbox-pop3d" will never require
18       write access to the directory where the public-inboxes are stored.
19
20       It is designed for anonymous access, thus the password is always
21       "anonymous" (all lower-case).
22
23       Usernames are of the format:
24
25               C<$UUID@$NEWSGROUP_NAME>
26
27       Where $UUID is the output of the uuidgen(1) command.  Dash ("-")
28       characters in UUIDs are ignored, and "[A-F]" hex characters are case-
29       insensitive.  Users should keep their UUIDs private to prevent others
30       from deleting unretrieved messages.  Users may switch to a new UUID at
31       any time to retrieve previously-retrieved messages.
32
33       Historical slices of 50K messages are available by suffixing the
34       integer $SLICE, where 0 is the oldest.
35
36               C<$UUID@$NEWSGROUP_NAME.$SLICE>
37
38       It may be run as a different user than the user running
39       public-inbox-watch(1), public-inbox-mda(1), or public-inbox-fetch(1).
40
41       To save storage, "publicinbox.pop3state" only stores the highest-
42       numbered deleted message
43

OPTIONS

45       See common options in "OPTIONS" in public-inbox-daemon(8).
46
47       -l PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
48       --listen PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
49           In addition to the normal "-l"/"--listen" switch described in
50           public-inbox-daemon(8), the "PROTOCOL" prefix (e.g. "pop3://" or
51           "pop3s://") may be specified to force a given protocol.
52
53           For STARTTLS and POP3S support, the "cert" and "key" may be
54           specified on a per-listener basis after a "?" character and
55           separated by ",".  These directives are per-directive, and it's
56           possible to use a different cert for every listener.
57
58       --cert /path/to/cert
59           The default TLS certificate for optional STARTTLS and POP3S support
60           if the "cert" option is not given with "--listen".
61
62           If using systemd-compatible socket activation and a TCP listener on
63           port 995 is inherited, it is automatically POP3S when this option
64           is given.  When a listener on port 110 is inherited and this option
65           is given, it automatically gets STARTTLS support.
66
67       --key /path/to/key
68           The default private TLS certificate key for optional STARTTLS and
69           POP3S support if the "key" option is not given with "--listen".
70           The private key may be concatenated into the path used by "--cert",
71           in which case this option is not needed.
72

CONFIGURATION

74       Aside from "publicinbox.pop3state", "public-inbox-pop3d" uses the same
75       configuration knobs as public-inbox-nntpd(1), see public-inbox-nntpd(1)
76       and public-inbox-config(5).
77
78       publicInbox.pop3state
79               A directory containing per-user/mailbox account information;
80               must be writable to the "public-inbox-pop3d" process.
81
82       publicInbox.<name>.newsgroup
83               The newsgroup name maps to a POP3 folder name.
84

CONTACT

86       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
87
88       The mail archives are hosted at <https://public-inbox.org/meta/>, and
89       <nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
90       <nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
91

COPYRIGHT

93       Copyright all contributors <mailto:meta@public-inbox.org>
94
95       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
96