public-inbox-glossary(7)

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

NAME

6       public-inbox-glossary - glossary for public-inbox
7

DESCRIPTION

9       public-inbox combines several independently-developed protocols and
10       data formats with overlapping concepts.  This document is intended as a
11       guide to identify and clarify overlapping concepts with different
12       names.
13
14       This is mainly intended for hackers of public-inbox, but may be useful
15       for administrators of public-facing services and/or users building
16       tools.
17

TERMS

19       IMAP UID, NNTP article number, on-disk Xapian docid
20               A sequentially-assigned positive integer.  These integers are
21               per-inbox, or per-extindex.  This is the "num" column of the
22               "over" table in "over.sqlite3"
23
24       tid, THREADID
25               A sequentially-assigned positive integer.  These integers are
26               per-inbox or per-extindex.  In the future, this may be prefixed
27               with "T" for JMAP (RFC 8621) and RFC 8474.  This may not be
28               strictly compliant with RFC 8621 since inboxes and extindices
29               are considered independent entities from each other.
30
31               This is the "tid" column of the "over" table in "over.sqlite3"
32
33       blob    For email, this is the git blob object ID (SHA-(1|256)) of an
34               RFC-(822|2822|5322) email message.
35
36       IMAP EMAILID, JMAP Email Id
37               To-be-decided.  This will likely be the git blob ID prefixed
38               with "g" rather than the numeric UID to accommodate the same
39               blob showing up in both an extindex and inbox (or multiple
40               extindices).
41
42       newsgroup
43               The name of the NNTP newsgroup, see public-inbox-config(5).
44
45       IMAP (folder|mailbox) slice
46               A 50K slice of a newsgroup to accommodate the limitations of
47               IMAP clients with public-inbox-imapd(1).  This is the
48               "newsgroup" name with a ".$INTEGER_SUFFIX", e.g. a newsgroup
49               named "inbox.test" would have its first slice named
50               "inbox.test.0", and second slice named "inbox.test.1" and so
51               forth.
52
53               If implemented, the RFC 8474 MAILBOXID of an IMAP slice will
54               NOT have the same Mailbox Id as the public-facing full JMAP
55               mailbox.
56
57       inbox name, public JMAP mailbox name
58               The HTTP(S) name of the public-inbox ("publicinbox.<name>.*").
59               JMAP will use this name rather than the newsgroup name since
60               public-facing JMAP will be part of the PSGI code and not need a
61               separate daemon like public-inbox-nntpd(1) or
62               public-inbox-imapd(1)
63
64       epoch   A git repository used for blob storage.  See "GIT EPOCHS" in
65               public-inbox-v2-format(5).
66
67       keywords, (IMAP|Maildir) flags, mbox Status + X-Status
68               Private, per-message keywords or flags as described in RFC 8621
69               section 10.4.  These are conveyed in the "Status:" and
70               "X-Status:" headers for mbox(5), as system IMAP FLAGS (RFC 3501
71               section 2.3.2), or Maildir info flags.
72
73               public-inbox-watch(1) ignores drafts and trashed (deleted)
74               messages.  lei-import(1) ignores trashed (deleted) messages,
75               but it imports drafts.
76
77       labels, private JMAP mailboxes
78               For lei(1) users only.  This will allow lei users to place the
79               same email into one or more virtual folders for ease-of-
80               filtering.  This is NOT tied to public-inbox names, as messages
81               stored by lei may not be public.
82
83               These are similar in spirit to arbitrary freeform "tags" in
84               mail software such as notmuch(1) and non-system IMAP FLAGS.
85
86       volatile metadata (VMD)
87               For lei(1) users only, this refers to the combination of
88               keywords and labels which are subject to frequent change
89               independently of immutable message content.
90
91       IMAP INTERNALDATE, JMAP receivedAt, rt: search prefix
92               The first valid timestamp value of Received: headers (top
93               first).  If no Received: header exists, the Date: header is
94               used, and the current time if neither header(s) exist.  When
95               mirroring via git, this is the git commit time.
96
97       IMAP SENT*, JMAP sentAt, dt: and d: search prefixes
98               The first valid timestamp value of the Date: header(s).  If no
99               Date: header exists, the time from the Received: header is
100               used, and then the current time if neither header exists.  When
101               mirroring via git, this is the git author time.
102

COPYRIGHT

104       Copyright 2021 all contributors <mailto:meta@public-inbox.org>
105
106       License: AGPL-3.0+ <http://www.gnu.org/licenses/agpl-3.0.txt>
107

NAME

DESCRIPTION

TERMS

COPYRIGHT

SEE ALSO