X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-glossary.pod;h=3c9e2bd212837e8a52a6974138ac8209ab047b4f;hb=ad655616d39ba3806a9c38f0febf456df0fa17bd;hp=61e1e9f8b1f777422ed8160779d3def9c67c2445;hpb=72cbfb826cd7827c92c239d8c1e81024514e211f;p=public-inbox.git diff --git a/Documentation/public-inbox-glossary.pod b/Documentation/public-inbox-glossary.pod index 61e1e9f8..3c9e2bd2 100644 --- a/Documentation/public-inbox-glossary.pod +++ b/Documentation/public-inbox-glossary.pod @@ -15,6 +15,8 @@ tools. =head1 TERMS +=over 8 + =item IMAP UID, NNTP article number, on-disk Xapian docid A sequentially-assigned positive integer. These integers are per-inbox, @@ -39,7 +41,7 @@ RFC-(822|2822|5322) email message. =item IMAP EMAILID, JMAP Email Id To-be-decided. This will likely be the git blob ID prefixed with C -rather than the numeric UID to accomodate the same blob showing +rather than the numeric UID to accommodate the same blob showing up in both an extindex and inbox (or multiple extindices). =item newsgroup @@ -48,7 +50,7 @@ The name of the NNTP newsgroup, see L. =item IMAP (folder|mailbox) slice -A 50K slice of a newsgroup to accomodate the limitations of IMAP +A 50K slice of a newsgroup to accommodate the limitations of IMAP clients with L. This is the C name with a C<.$INTEGER_SUFFIX>, e.g. a newsgroup named C would have its first slice named C, and second slice @@ -65,12 +67,17 @@ rather than the newsgroup name since public-facing JMAP will be part of the PSGI code and not need a separate daemon like L or L +=item epoch + +A git repository used for blob storage. See +L. + =item keywords, (IMAP|Maildir) flags, mbox Status + X-Status Private, per-message keywords or flags as described in RFC 8621 section 10.4. These are conveyed in the C and -C headers for L, as IMAP FLAGS (RFC 3501 section 2.3.2), -or Maildir info flags. +C headers for L, as system IMAP FLAGS +(RFC 3501 section 2.3.2), or Maildir info flags. L ignores drafts and trashed (deleted) messages. L ignores trashed (deleted) messages, @@ -83,6 +90,15 @@ the same email into one or more virtual folders for ease-of-filtering. This is NOT tied to public-inbox names, as messages stored by lei may not be public. +These are similar in spirit to arbitrary freeform "tags" +in mail software such as L and non-system IMAP FLAGS. + +=item volatile metadata (VMD) + +For L users only, this refers to the combination of +keywords and labels which are subject to frequent change +independently of immutable message content. + =item IMAP INTERNALDATE, JMAP receivedAt, rt: search prefix The first valid timestamp value of Received: headers (top first). @@ -97,6 +113,8 @@ If no Date: header exists, the time from the Received: header is used, and then the current time if neither header exists. When mirroring via git, this is the git author time. +=back + =head1 COPYRIGHT Copyright 2021 all contributors L